OpenAPI SpecificationJSON
API Reference

Workspace

A workspace object is a container of queue objects.

Workspace

Attribute
Type
Description
id*
read-only
integer

ID of the workspace

name*
string

Name of the workspace

url*
read-only
URL

URL of the workspace

autopilot*
deprecatedread-only
boolean

Whether to automatically confirm datapoints from previously seen annotations.

Note: Please note that autopilot configuration has been moved to Queue. Option autopilot remains read-only on Workspace and represents autopilot configuration set to queues within a workspace.

organization*
URL

Organization URL.

queues*
read-only
list[URL]

List of queues that belongs to the workspace

metadata*
object

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

Default: {}
created_by*
read-only
URL

URL of the workspace creator. Might be null for workspaces created before April 2026.

created_at*
read-only
datetime

Date of workspace creation. Might be null for workspaces created before April 2026.

modified_by*
read-only
URL

User that last modified the object.

modified_at*
read-only
datetime

Timestamp of last modification.

List workspaces

GET api / v1 / workspaces

Retrieve all workspace objects.

GET
/api/v1/workspaces
curl -X GET "https://example.rossum.app/api/v1/workspaces"
{
  "pagination": {
    "next": null,
    "previous": null
  },
  "results": [
    {
      "id": 7540,
      "name": "East West Trading Co",
      "url": "https://example.rossum.app/api/v1/workspaces/7540",
      "autopilot": true,
      "organization": "https://example.rossum.app/api/v1/organizations/406",
      "queues": [
        "https://example.rossum.app/api/v1/queues/8199",
        "https://example.rossum.app/api/v1/queues/8236"
      ],
      "metadata": {
        "some_key": "some_value"
      },
      "created_by": "https://example.rossum.app/api/v1/users/10775",
      "created_at": "2021-04-26T10:08:03.856648Z",
      "modified_by": "https://example.rossum.app/api/v1/users/10775",
      "modified_at": "2021-04-26T10:08:03.856648Z"
    }
  ]
}
{
  "detail": "Bad Request.",
  "code": "bad_request"
}
{
  "detail": "Invalid token.",
  "code": "authentication_failed"
}
{
  "detail": "Access to the requested resource is forbidden.",
  "code": "access_forbidden"
}
{
  "detail": "Not found.",
  "code": "not_found"
}
{
  "detail": "Conflict.",
  "code": "conflict_status"
}
{
  "detail": "Request was rate limited.",
  "code": "rate_limited",
  "url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}
{
  "detail": "Server error.",
  "code": "error"
}
{
  "detail": "Bad Gateway.",
  "code": "bad_gateway"
}
{
  "detail": "Service Unavailable.",
  "code": "service_unavailable"
}
{
  "detail": "Gateway timeout.",
  "code": "gateway_timeout"
}

Response

200OK

OK

Attribute
Type
Description
pagination*
pagination
next
URL

URL for the next page of results. Contains an opaque signed cursor query parameter. Use this URL directly to fetch the next page — do not attempt to construct or modify the cursor value.

previous
URL

URL for the previous page of results. Contains an opaque signed cursor query parameter. Use this URL directly to fetch the previous page — do not attempt to construct or modify the cursor value.

results*
list[workspace]
id*
read-only
integer

ID of the workspace

name*
string

Name of the workspace

url*
read-only
URL

URL of the workspace

autopilot*
deprecatedread-only
boolean

Whether to automatically confirm datapoints from previously seen annotations.

Note: Please note that autopilot configuration has been moved to Queue. Option autopilot remains read-only on Workspace and represents autopilot configuration set to queues within a workspace.

organization*
URL

Organization URL.

queues*
read-only
list[URL]

List of queues that belongs to the workspace

metadata*
object

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

Default: {}
created_by*
read-only
URL

URL of the workspace creator. Might be null for workspaces created before April 2026.

created_at*
read-only
datetime

Date of workspace creation. Might be null for workspaces created before April 2026.

modified_by*
read-only
URL

User that last modified the object.

modified_at*
read-only
datetime

Timestamp of last modification.

400Bad Request

Invalid input data.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

401Unauthorized

The username/password is invalid or token is invalid (e.g. expired).

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

403Forbidden

Insufficient permission, missing authentication, invalid CSRF token and similar issue.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

404Not Found

The specified resource was not found.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

409Conflict

Conflict

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

429Too Many Requests

Request rate is too high, wait before sending more requests. See Rate Limiting for more details.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

url
read-only
string

Link to the rate limiting documentation

500Internal Server Error

Server failure while processing the request.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

502Bad Gateway

Invalid response from the upstream server.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

503Service Unavailable

We're temporarily offline for maintenance. Please try again later.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

504

Upstream server could not complete the request in time.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

Create workspace

POST api / v1 / workspaces

Create a new workspace object.

POST
/api/v1/workspaces
curl -X POST "https://example.rossum.app/api/v1/workspaces" \  -H "Content-Type: application/json" \  -d '{    "name": "East West Trading Co",    "organization": "https://example.rossum.app/api/v1/organizations/406"  }'
{
  "id": 7540,
  "name": "East West Trading Co",
  "url": "https://example.rossum.app/api/v1/workspaces/7540",
  "autopilot": true,
  "organization": "https://example.rossum.app/api/v1/organizations/406",
  "queues": [
    "https://example.rossum.app/api/v1/queues/8199",
    "https://example.rossum.app/api/v1/queues/8236"
  ],
  "metadata": {
    "some_key": "some_value"
  },
  "created_by": "https://example.rossum.app/api/v1/users/10775",
  "created_at": "2021-04-26T10:08:03.856648Z",
  "modified_by": "https://example.rossum.app/api/v1/users/10775",
  "modified_at": "2021-04-26T10:08:03.856648Z"
}
{
  "detail": "Bad Request.",
  "code": "bad_request"
}
{
  "detail": "Invalid token.",
  "code": "authentication_failed"
}
{
  "detail": "Access to the requested resource is forbidden.",
  "code": "access_forbidden"
}
{
  "detail": "Not found.",
  "code": "not_found"
}
{
  "detail": "Conflict.",
  "code": "conflict_status"
}
{
  "detail": "Payload Too Large.",
  "code": "payload_too_large"
}
{
  "detail": "Request was rate limited.",
  "code": "rate_limited",
  "url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}
{
  "detail": "Server error.",
  "code": "error"
}
{
  "detail": "Bad Gateway.",
  "code": "bad_gateway"
}
{
  "detail": "Service Unavailable.",
  "code": "service_unavailable"
}
{
  "detail": "Gateway timeout.",
  "code": "gateway_timeout"
}

Request Body

application/json

Attribute
Type
Description
name*
string

Name of the workspace

organization*
URL

Organization URL.

metadata
object

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

Default: {}

Response

201Created

Created

Attribute
Type
Description
id*
read-only
integer

ID of the workspace

name*
string

Name of the workspace

url*
read-only
URL

URL of the workspace

autopilot*
deprecatedread-only
boolean

Whether to automatically confirm datapoints from previously seen annotations.

Note: Please note that autopilot configuration has been moved to Queue. Option autopilot remains read-only on Workspace and represents autopilot configuration set to queues within a workspace.

organization*
URL

Organization URL.

queues*
read-only
list[URL]

List of queues that belongs to the workspace

metadata*
object

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

Default: {}
created_by*
read-only
URL

URL of the workspace creator. Might be null for workspaces created before April 2026.

created_at*
read-only
datetime

Date of workspace creation. Might be null for workspaces created before April 2026.

modified_by*
read-only
URL

User that last modified the object.

modified_at*
read-only
datetime

Timestamp of last modification.

400Bad Request

Invalid input data.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

401Unauthorized

The username/password is invalid or token is invalid (e.g. expired).

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

403Forbidden

Insufficient permission, missing authentication, invalid CSRF token and similar issue.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

404Not Found

The specified resource was not found.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

409Conflict

Conflict

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

413

Payload too large (especially for files uploaded).

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

429Too Many Requests

Request rate is too high, wait before sending more requests. See Rate Limiting for more details.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

url
read-only
string

Link to the rate limiting documentation

500Internal Server Error

Server failure while processing the request.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

502Bad Gateway

Invalid response from the upstream server.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

503Service Unavailable

We're temporarily offline for maintenance. Please try again later.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

504

Upstream server could not complete the request in time.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

Retrieve workspace

GET api / v1 / workspaces / {workspaceID}

Get a workspace object.

GET
/api/v1/workspaces/{workspaceID}
curl -X GET "https://example.rossum.app/api/v1/workspaces/0"
{
  "id": 7540,
  "name": "East West Trading Co",
  "url": "https://example.rossum.app/api/v1/workspaces/7540",
  "autopilot": true,
  "organization": "https://example.rossum.app/api/v1/organizations/406",
  "queues": [
    "https://example.rossum.app/api/v1/queues/8199",
    "https://example.rossum.app/api/v1/queues/8236"
  ],
  "metadata": {
    "some_key": "some_value"
  },
  "created_by": "https://example.rossum.app/api/v1/users/10775",
  "created_at": "2021-04-26T10:08:03.856648Z",
  "modified_by": "https://example.rossum.app/api/v1/users/10775",
  "modified_at": "2021-04-26T10:08:03.856648Z"
}
{
  "detail": "Bad Request.",
  "code": "bad_request"
}
{
  "detail": "Invalid token.",
  "code": "authentication_failed"
}
{
  "detail": "Access to the requested resource is forbidden.",
  "code": "access_forbidden"
}
{
  "detail": "Not found.",
  "code": "not_found"
}
{
  "detail": "Conflict.",
  "code": "conflict_status"
}
{
  "detail": "Request was rate limited.",
  "code": "rate_limited",
  "url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}
{
  "detail": "Server error.",
  "code": "error"
}
{
  "detail": "Bad Gateway.",
  "code": "bad_gateway"
}
{
  "detail": "Service Unavailable.",
  "code": "service_unavailable"
}
{
  "detail": "Gateway timeout.",
  "code": "gateway_timeout"
}

Response

200OK

OK

Attribute
Type
Description
id*
read-only
integer

ID of the workspace

name*
string

Name of the workspace

url*
read-only
URL

URL of the workspace

autopilot*
deprecatedread-only
boolean

Whether to automatically confirm datapoints from previously seen annotations.

Note: Please note that autopilot configuration has been moved to Queue. Option autopilot remains read-only on Workspace and represents autopilot configuration set to queues within a workspace.

organization*
URL

Organization URL.

queues*
read-only
list[URL]

List of queues that belongs to the workspace

metadata*
object

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

Default: {}
created_by*
read-only
URL

URL of the workspace creator. Might be null for workspaces created before April 2026.

created_at*
read-only
datetime

Date of workspace creation. Might be null for workspaces created before April 2026.

modified_by*
read-only
URL

User that last modified the object.

modified_at*
read-only
datetime

Timestamp of last modification.

400Bad Request

Invalid input data.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

401Unauthorized

The username/password is invalid or token is invalid (e.g. expired).

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

403Forbidden

Insufficient permission, missing authentication, invalid CSRF token and similar issue.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

404Not Found

The specified resource was not found.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

409Conflict

Conflict

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

429Too Many Requests

Request rate is too high, wait before sending more requests. See Rate Limiting for more details.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

url
read-only
string

Link to the rate limiting documentation

500Internal Server Error

Server failure while processing the request.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

502Bad Gateway

Invalid response from the upstream server.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

503Service Unavailable

We're temporarily offline for maintenance. Please try again later.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

504

Upstream server could not complete the request in time.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

Partial update workspace

PATCH api / v1 / workspaces / {workspaceID}

Update part of workspace object.

PATCH
/api/v1/workspaces/{workspaceID}
curl -X PATCH "https://example.rossum.app/api/v1/workspaces/0" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": 7540,
  "name": "East West Trading Co",
  "url": "https://example.rossum.app/api/v1/workspaces/7540",
  "autopilot": true,
  "organization": "https://example.rossum.app/api/v1/organizations/406",
  "queues": [
    "https://example.rossum.app/api/v1/queues/8199",
    "https://example.rossum.app/api/v1/queues/8236"
  ],
  "metadata": {
    "some_key": "some_value"
  },
  "created_by": "https://example.rossum.app/api/v1/users/10775",
  "created_at": "2021-04-26T10:08:03.856648Z",
  "modified_by": "https://example.rossum.app/api/v1/users/10775",
  "modified_at": "2021-04-26T10:08:03.856648Z"
}
{
  "detail": "Bad Request.",
  "code": "bad_request"
}
{
  "detail": "Invalid token.",
  "code": "authentication_failed"
}
{
  "detail": "Access to the requested resource is forbidden.",
  "code": "access_forbidden"
}
{
  "detail": "Not found.",
  "code": "not_found"
}
{
  "detail": "Conflict.",
  "code": "conflict_status"
}
{
  "detail": "Payload Too Large.",
  "code": "payload_too_large"
}
{
  "detail": "Request was rate limited.",
  "code": "rate_limited",
  "url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}
{
  "detail": "Server error.",
  "code": "error"
}
{
  "detail": "Bad Gateway.",
  "code": "bad_gateway"
}
{
  "detail": "Service Unavailable.",
  "code": "service_unavailable"
}
{
  "detail": "Gateway timeout.",
  "code": "gateway_timeout"
}

Request Body

application/json

Attribute
Type
Description
name
string

Name of the workspace

organization
URL

Organization URL.

metadata
object

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

Default: {}

Response

200OK

OK

Attribute
Type
Description
id*
read-only
integer

ID of the workspace

name*
string

Name of the workspace

url*
read-only
URL

URL of the workspace

autopilot*
deprecatedread-only
boolean

Whether to automatically confirm datapoints from previously seen annotations.

Note: Please note that autopilot configuration has been moved to Queue. Option autopilot remains read-only on Workspace and represents autopilot configuration set to queues within a workspace.

organization*
URL

Organization URL.

queues*
read-only
list[URL]

List of queues that belongs to the workspace

metadata*
object

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

Default: {}
created_by*
read-only
URL

URL of the workspace creator. Might be null for workspaces created before April 2026.

created_at*
read-only
datetime

Date of workspace creation. Might be null for workspaces created before April 2026.

modified_by*
read-only
URL

User that last modified the object.

modified_at*
read-only
datetime

Timestamp of last modification.

400Bad Request

Invalid input data.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

401Unauthorized

The username/password is invalid or token is invalid (e.g. expired).

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

403Forbidden

Insufficient permission, missing authentication, invalid CSRF token and similar issue.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

404Not Found

The specified resource was not found.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

409Conflict

Conflict

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

413

Payload too large (especially for files uploaded).

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

429Too Many Requests

Request rate is too high, wait before sending more requests. See Rate Limiting for more details.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

url
read-only
string

Link to the rate limiting documentation

500Internal Server Error

Server failure while processing the request.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

502Bad Gateway

Invalid response from the upstream server.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

503Service Unavailable

We're temporarily offline for maintenance. Please try again later.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

504

Upstream server could not complete the request in time.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

Delete workspace

DELETE api / v1 / workspaces / {workspaceID}

Delete workspace object.

Note: Please note that only empty workspaces without queues can be deleted. To delete a non-empty workspace, first delete all related queues.

DELETE
/api/v1/workspaces/{workspaceID}
curl -X DELETE "https://example.rossum.app/api/v1/workspaces/0"
Empty
{
  "detail": "Bad Request.",
  "code": "bad_request"
}
{
  "detail": "Invalid token.",
  "code": "authentication_failed"
}
{
  "detail": "Access to the requested resource is forbidden.",
  "code": "access_forbidden"
}
{
  "detail": "Not found.",
  "code": "not_found"
}
{
  "detail": "Cannot delete workspace East West Trading Co because it contains queues with ids: [...].",
  "code": "conflict_referenced"
}
{
  "detail": "Request was rate limited.",
  "code": "rate_limited",
  "url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}
{
  "detail": "Server error.",
  "code": "error"
}
{
  "detail": "Bad Gateway.",
  "code": "bad_gateway"
}
{
  "detail": "Service Unavailable.",
  "code": "service_unavailable"
}
{
  "detail": "Gateway timeout.",
  "code": "gateway_timeout"
}

Response

204No Content

No Content

No response body.

400Bad Request

Invalid input data.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

401Unauthorized

The username/password is invalid or token is invalid (e.g. expired).

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

403Forbidden

Insufficient permission, missing authentication, invalid CSRF token and similar issue.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

404Not Found

The specified resource was not found.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

409Conflict

Conflict - workspace is not empty

responseobject

This error object can have any number of properties, and their names and types are not predefined.

429Too Many Requests

Request rate is too high, wait before sending more requests. See Rate Limiting for more details.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

url
read-only
string

Link to the rate limiting documentation

500Internal Server Error

Server failure while processing the request.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

502Bad Gateway

Invalid response from the upstream server.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

503Service Unavailable

We're temporarily offline for maintenance. Please try again later.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

504

Upstream server could not complete the request in time.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

Update workspace

PUT api / v1 / workspaces / {workspaceID}

Update workspace object.

PUT
/api/v1/workspaces/{workspaceID}
curl -X PUT "https://example.rossum.app/api/v1/workspaces/0" \  -H "Content-Type: application/json" \  -d '{    "name": "East West Trading Co",    "organization": "https://example.rossum.app/api/v1/organizations/406"  }'
{
  "id": 7540,
  "name": "East West Trading Co",
  "url": "https://example.rossum.app/api/v1/workspaces/7540",
  "autopilot": true,
  "organization": "https://example.rossum.app/api/v1/organizations/406",
  "queues": [
    "https://example.rossum.app/api/v1/queues/8199",
    "https://example.rossum.app/api/v1/queues/8236"
  ],
  "metadata": {
    "some_key": "some_value"
  },
  "created_by": "https://example.rossum.app/api/v1/users/10775",
  "created_at": "2021-04-26T10:08:03.856648Z",
  "modified_by": "https://example.rossum.app/api/v1/users/10775",
  "modified_at": "2021-04-26T10:08:03.856648Z"
}
{
  "detail": "Bad Request.",
  "code": "bad_request"
}
{
  "detail": "Invalid token.",
  "code": "authentication_failed"
}
{
  "detail": "Access to the requested resource is forbidden.",
  "code": "access_forbidden"
}
{
  "detail": "Not found.",
  "code": "not_found"
}
{
  "detail": "Conflict.",
  "code": "conflict_status"
}
{
  "detail": "Payload Too Large.",
  "code": "payload_too_large"
}
{
  "detail": "Request was rate limited.",
  "code": "rate_limited",
  "url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}
{
  "detail": "Server error.",
  "code": "error"
}
{
  "detail": "Bad Gateway.",
  "code": "bad_gateway"
}
{
  "detail": "Service Unavailable.",
  "code": "service_unavailable"
}
{
  "detail": "Gateway timeout.",
  "code": "gateway_timeout"
}

Request Body

application/json

Attribute
Type
Description
name*
string

Name of the workspace

organization*
URL

Organization URL.

metadata
object

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

Default: {}

Response

200OK

OK

Attribute
Type
Description
id*
read-only
integer

ID of the workspace

name*
string

Name of the workspace

url*
read-only
URL

URL of the workspace

autopilot*
deprecatedread-only
boolean

Whether to automatically confirm datapoints from previously seen annotations.

Note: Please note that autopilot configuration has been moved to Queue. Option autopilot remains read-only on Workspace and represents autopilot configuration set to queues within a workspace.

organization*
URL

Organization URL.

queues*
read-only
list[URL]

List of queues that belongs to the workspace

metadata*
object

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

Default: {}
created_by*
read-only
URL

URL of the workspace creator. Might be null for workspaces created before April 2026.

created_at*
read-only
datetime

Date of workspace creation. Might be null for workspaces created before April 2026.

modified_by*
read-only
URL

User that last modified the object.

modified_at*
read-only
datetime

Timestamp of last modification.

400Bad Request

Invalid input data.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

401Unauthorized

The username/password is invalid or token is invalid (e.g. expired).

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

403Forbidden

Insufficient permission, missing authentication, invalid CSRF token and similar issue.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

404Not Found

The specified resource was not found.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

409Conflict

Conflict

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

413

Payload too large (especially for files uploaded).

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

429Too Many Requests

Request rate is too high, wait before sending more requests. See Rate Limiting for more details.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

url
read-only
string

Link to the rate limiting documentation

500Internal Server Error

Server failure while processing the request.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

502Bad Gateway

Invalid response from the upstream server.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

503Service Unavailable

We're temporarily offline for maintenance. Please try again later.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

504

Upstream server could not complete the request in time.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

GETRetrieve workflow step

Previous Page

GETList workspaces

Next Page