Machines

Get Machines

get

Returns a list of machines in your organization.

Authorizations

Bearer

AuthorizationstringRequired

Query parameters

sitestring · uuid[] · max: 50 · nullableOptional

cursorstringOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get/v2/machines

HTTPcURLJavaScriptPython

GET /api/v2/machines HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "site": "123e4567-e89b-12d3-a456-426614174000",
      "genesis_date": "2026-07-18"
    }
  ],
  "metadata": {
    "next_cursor": "text"
  }
}

Create Machine

post

Create a new machine.

Authorizations

Bearer

AuthorizationstringRequired

Body

application/json

namestring · min: 1Required

Name of your Machine. Can be changed later

Example: Extruder X

sitestring · uuidRequired

UUID of the site this machine belongs to

Responses

201

Successful Response

application/json

uuidstring · uuidRequired

namestringRequired

sitestring · uuidRequired

genesis_datestring · dateRequired

422

Validation Error

application/json

post/v2/machines

HTTPcURLJavaScriptPython

POST /api/v2/machines HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "name": "Extruder X",
  "site": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "site": "123e4567-e89b-12d3-a456-426614174000",
  "genesis_date": "2026-07-18"
}

Get Machine

get

Returns details for a specific machine.

Authorizations

Bearer

AuthorizationstringRequired

Path parameters

uuidstring · uuidRequired

Responses

200

Successful Response

application/json

uuidstring · uuidRequired

namestringRequired

sitestring · uuidRequired

genesis_datestring · dateRequired

422

Validation Error

application/json

get/v2/machines/{uuid}

HTTPcURLJavaScriptPython

GET /api/v2/machines/{uuid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "site": "123e4567-e89b-12d3-a456-426614174000",
  "genesis_date": "2026-07-18"
}

Update Machine

patch

Update a machine.

Authorizations

Bearer

AuthorizationstringRequired

Path parameters

uuidstring · uuidRequired

Body

application/json

namestring · min: 1Optional

Name of your Machine. Can be changed later

Example: Extruder X

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

patch/v2/machines/{uuid}

HTTPcURLJavaScriptPython

PATCH /api/v2/machines/{uuid} HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "name": "Extruder X"
}

No content

Delete Machine

delete

Delete a machine

Authorizations

Bearer

AuthorizationstringRequired

Path parameters

machine_uuidstring · uuidRequired

Responses

204

Successful Response

No content

422

Validation Error

application/json

delete/v2/machines/{machine_uuid}

HTTPcURLJavaScriptPython

DELETE /api/v2/machines/{machine_uuid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content

Productivity Metrics

post

Get productivity metrics for a specific machine over a set of datetime ranges.

Authorizations

Bearer

AuthorizationstringRequired

Path parameters

uuidstring · uuidRequired

Body

application/json

cursorstringOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post/v2/machines/{uuid}/productivity-metrics

HTTPcURLJavaScriptPython

POST /api/v2/machines/{uuid}/productivity-metrics HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 107

{
  "datetime_ranges": [
    {
      "start": "2026-07-18T00:03:55.530Z",
      "end": "2026-07-18T00:03:55.530Z"
    }
  ],
  "cursor": "text"
}

{
  "data": [
    {
      "start": "2026-07-18T00:03:55.530Z",
      "end": "2026-07-18T00:03:55.530Z",
      "availability": {
        "score": 1,
        "time_loss": 1
      },
      "performance": {
        "score": 1,
        "time_loss": 1
      },
      "quality": {
        "score": 1,
        "time_loss": 1
      },
      "productivity": {
        "score": 1,
        "time_loss": 1
      },
      "quantity_scrap": {
        "unit": "text",
        "value": 1
      },
      "quantity_yield": {
        "unit": "text",
        "value": 1
      }
    }
  ],
  "metadata": {
    "next_cursor": "text"
  }
}