Dedicated Engine Schema

An engine schema is an object which describes what fields are available in the engine. Do not confuse engine schema with Schema.

Talk with a Rossum representative about enabling this feature. You can create new Dedicated Engine objects. However, no Dedicated Engine will be trained unless Dedicated Engines are part of your agreement.

Schema can be edited only if its Dedicated Engine has status draft.

Dedicated engine schema

Attribute

Type

Description

id*

read-only

integer

ID of the engine schema.

url*

read-only

URL

URL of the engine schema.

content*

object

training_queues

list[URL]

List of Queues that will be used for the training. Note that queues can't have delete_after field set, otherwise a validation error is raised.

fields

list[object]

Container for fields declarations. It may contain only objects of category multivalue or datapoint.

category

"multivalue"

Category of the object.

engine_output_id

string

Unique name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

trained

read-only

boolean

Whether the field was successfully trained.

type

"grid" | "freeform"

Type of the trained field.

description

string

Description of field attribute.

children

object

Object specifying type of children. It may contain only objects with category tuple.

category

"tuple"

Category of the object.

children

list[object]

Array specifying objects that belong to a given tuple. It may contain only objects with category datapoint.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

trained

read-only

boolean

Whether the field was successfully trained.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

category

"multivalue"

Category of the object.

children

object

Object specifying type of children. It may contain only objects with category datapoint.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

trained

read-only

boolean

Whether the field was successfully trained.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

trained

read-only

boolean

Whether the field was successfully trained.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

deprecated

List dedicated engine schemas

Retrieve all dedicated engine schema objects.

Please note that Dedicated Engine Schema is an internal API and can be changed without notice.

curl -X GET "https://example.rossum.app/api/v1/dedicated_engine_schemas"

curl -X GET "https://example.rossum.app/api/v1/dedicated_engine_schemas"

{
  "pagination": {
    "next": null,
    "previous": null
  },
  "results": [
    {
      "id": 6000,
      "url": "https://example.rossum.app/api/v1/dedicated_engine_schemas/6000",
      "content": {
        "training_queues": [
          "https://example.rossum.app/api/v1/queues/123",
          "https://example.rossum.app/api/v1/queues/200",
          "https://example.rossum.app/api/v1/queues/321"
        ],
        "fields": [
          {
            "category": "multivalue",
            "engine_output_id": "line_items",
            "label": "Line Items",
            "trained": true,
            "type": "grid",
            "description": "Line item column types.",
            "children": {
              "category": "tuple",
              "children": [
                {
                  "category": "datapoint",
                  "engine_output_id": "document_id",
                  "label": "Document ID",
                  "trained": true,
                  "type": "string",
                  "description": "Document number",
                  "sources": [
                    {
                      "queue": "string",
                      "schema_id": "document_id"
                    }
                  ]
                }
              ]
            }
          }
        ]
      }
    }
  ]
}

{
  "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

Attribute

Type

Description

pagination*

pagination

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.

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[dedicated_engine_schema]

id*

read-only

integer

ID of the engine schema.

url*

read-only

URL

URL of the engine schema.

content*

object

training_queues

list[URL]

List of Queues that will be used for the training. Note that queues can't have delete_after field set, otherwise a validation error is raised.

fields

list[object]

Container for fields declarations. It may contain only objects of category multivalue or datapoint.

category

"multivalue"

Category of the object.

engine_output_id

string

Unique name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

trained

read-only

boolean

Whether the field was successfully trained.

type

"grid" | "freeform"

Type of the trained field.

description

string

Description of field attribute.

children

object

Object specifying type of children. It may contain only objects with category tuple.

category

"tuple"

Category of the object.

children

list[object]

Array specifying objects that belong to a given tuple. It may contain only objects with category datapoint.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

trained

read-only

boolean

Whether the field was successfully trained.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

category

"multivalue"

Category of the object.

children

object

Object specifying type of children. It may contain only objects with category datapoint.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

trained

read-only

boolean

Whether the field was successfully trained.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

trained

read-only

boolean

Whether the field was successfully trained.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

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

deprecated

Create dedicated engine schema

Create a new dedicated engine schema object.

curl -X POST "https://example.rossum.app/api/v1/dedicated_engine_schemas" \
  -H "Content-Type: application/json" \
  -d '{
    "content": {}
  }'

curl -X POST "https://example.rossum.app/api/v1/dedicated_engine_schemas" \  -H "Content-Type: application/json" \  -d '{    "content": {}  }'

{
  "id": 6000,
  "url": "https://example.rossum.app/api/v1/dedicated_engine_schemas/6000",
  "content": {
    "training_queues": [
      "https://example.rossum.app/api/v1/queues/123",
      "https://example.rossum.app/api/v1/queues/200",
      "https://example.rossum.app/api/v1/queues/321"
    ],
    "fields": [
      {
        "category": "multivalue",
        "engine_output_id": "line_items",
        "label": "Line Items",
        "trained": true,
        "type": "grid",
        "description": "Line item column types.",
        "children": {
          "category": "tuple",
          "children": [
            {
              "category": "datapoint",
              "engine_output_id": "document_id",
              "label": "Document ID",
              "trained": true,
              "type": "string",
              "description": "Document number",
              "sources": [
                {
                  "queue": "string",
                  "schema_id": "document_id"
                }
              ]
            }
          ]
        }
      }
    ]
  }
}

{
  "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

content*

object

training_queues

list[URL]

List of Queues that will be used for the training. Note that queues can't have delete_after field set, otherwise a validation error is raised.

fields

list[object]

Container for fields declarations. It may contain only objects of category multivalue or datapoint.

category

"multivalue"

Category of the object.

engine_output_id

string

Unique name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

type

"grid" | "freeform"

Type of the trained field.

description

string

Description of field attribute.

children

object

Object specifying type of children. It may contain only objects with category tuple.

category

"tuple"

Category of the object.

children

list[object]

Array specifying objects that belong to a given tuple. It may contain only objects with category datapoint.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

category

"multivalue"

Category of the object.

children

object

Object specifying type of children. It may contain only objects with category datapoint.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

Response

201Created

Created

Attribute

Type

Description

id*

read-only

integer

ID of the engine schema.

url*

read-only

URL

URL of the engine schema.

content*

object

training_queues

list[URL]

List of Queues that will be used for the training. Note that queues can't have delete_after field set, otherwise a validation error is raised.

fields

list[object]

Container for fields declarations. It may contain only objects of category multivalue or datapoint.

category

"multivalue"

Category of the object.

engine_output_id

string

Unique name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

trained

read-only

boolean

Whether the field was successfully trained.

type

"grid" | "freeform"

Type of the trained field.

description

string

Description of field attribute.

children

object

Object specifying type of children. It may contain only objects with category tuple.

category

"tuple"

Category of the object.

children

list[object]

Array specifying objects that belong to a given tuple. It may contain only objects with category datapoint.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

trained

read-only

boolean

Whether the field was successfully trained.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

category

"multivalue"

Category of the object.

children

object

Object specifying type of children. It may contain only objects with category datapoint.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

trained

read-only

boolean

Whether the field was successfully trained.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

trained

read-only

boolean

Whether the field was successfully trained.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

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

deprecated

Retrieve dedicated engine schema

Get a dedicated engine schema object.

curl -X GET "https://example.rossum.app/api/v1/dedicated_engine_schemas/0"

curl -X GET "https://example.rossum.app/api/v1/dedicated_engine_schemas/0"

{
  "id": 6000,
  "url": "https://example.rossum.app/api/v1/dedicated_engine_schemas/6000",
  "content": {
    "training_queues": [
      "https://example.rossum.app/api/v1/queues/123",
      "https://example.rossum.app/api/v1/queues/200",
      "https://example.rossum.app/api/v1/queues/321"
    ],
    "fields": [
      {
        "category": "multivalue",
        "engine_output_id": "line_items",
        "label": "Line Items",
        "trained": true,
        "type": "grid",
        "description": "Line item column types.",
        "children": {
          "category": "tuple",
          "children": [
            {
              "category": "datapoint",
              "engine_output_id": "document_id",
              "label": "Document ID",
              "trained": true,
              "type": "string",
              "description": "Document number",
              "sources": [
                {
                  "queue": "string",
                  "schema_id": "document_id"
                }
              ]
            }
          ]
        }
      }
    ]
  }
}

{
  "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

Attribute

Type

Description

id*

read-only

integer

ID of the engine schema.

url*

read-only

URL

URL of the engine schema.

content*

object

training_queues

list[URL]

List of Queues that will be used for the training. Note that queues can't have delete_after field set, otherwise a validation error is raised.

fields

list[object]

Container for fields declarations. It may contain only objects of category multivalue or datapoint.

category

"multivalue"

Category of the object.

engine_output_id

string

Unique name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

trained

read-only

boolean

Whether the field was successfully trained.

type

"grid" | "freeform"

Type of the trained field.

description

string

Description of field attribute.

children

object

Object specifying type of children. It may contain only objects with category tuple.

category

"tuple"

Category of the object.

children

list[object]

Array specifying objects that belong to a given tuple. It may contain only objects with category datapoint.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

trained

read-only

boolean

Whether the field was successfully trained.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

category

"multivalue"

Category of the object.

children

object

Object specifying type of children. It may contain only objects with category datapoint.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

trained

read-only

boolean

Whether the field was successfully trained.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

trained

read-only

boolean

Whether the field was successfully trained.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

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

deprecated

Partial update dedicated engine schema

Update part of a dedicated engine schema object.

Please note that Dedicated Engine Schema is an internal API and can be changed without notice.

curl -X PATCH "https://example.rossum.app/api/v1/dedicated_engine_schemas/0" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X PATCH "https://example.rossum.app/api/v1/dedicated_engine_schemas/0" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": 6000,
  "url": "https://example.rossum.app/api/v1/dedicated_engine_schemas/6000",
  "content": {
    "training_queues": [
      "https://example.rossum.app/api/v1/queues/123",
      "https://example.rossum.app/api/v1/queues/200",
      "https://example.rossum.app/api/v1/queues/321"
    ],
    "fields": [
      {
        "category": "multivalue",
        "engine_output_id": "line_items",
        "label": "Line Items",
        "trained": true,
        "type": "grid",
        "description": "Line item column types.",
        "children": {
          "category": "tuple",
          "children": [
            {
              "category": "datapoint",
              "engine_output_id": "document_id",
              "label": "Document ID",
              "trained": true,
              "type": "string",
              "description": "Document number",
              "sources": [
                {
                  "queue": "string",
                  "schema_id": "document_id"
                }
              ]
            }
          ]
        }
      }
    ]
  }
}

{
  "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

content

object

training_queues

list[URL]

List of Queues that will be used for the training. Note that queues can't have delete_after field set, otherwise a validation error is raised.

fields

list[object]

Container for fields declarations. It may contain only objects of category multivalue or datapoint.

category

"multivalue"

Category of the object.

engine_output_id

string

Unique name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

type

"grid" | "freeform"

Type of the trained field.

description

string

Description of field attribute.

children

object

Object specifying type of children. It may contain only objects with category tuple.

category

"tuple"

Category of the object.

children

list[object]

Array specifying objects that belong to a given tuple. It may contain only objects with category datapoint.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

category

"multivalue"

Category of the object.

children

object

Object specifying type of children. It may contain only objects with category datapoint.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

Response

200OK

Attribute

Type

Description

id*

read-only

integer

ID of the engine schema.

url*

read-only

URL

URL of the engine schema.

content*

object

training_queues

list[URL]

List of Queues that will be used for the training. Note that queues can't have delete_after field set, otherwise a validation error is raised.

fields

list[object]

Container for fields declarations. It may contain only objects of category multivalue or datapoint.

category

"multivalue"

Category of the object.

engine_output_id

string

Unique name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

trained

read-only

boolean

Whether the field was successfully trained.

type

"grid" | "freeform"

Type of the trained field.

description

string

Description of field attribute.

children

object

Object specifying type of children. It may contain only objects with category tuple.

category

"tuple"

Category of the object.

children

list[object]

Array specifying objects that belong to a given tuple. It may contain only objects with category datapoint.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

trained

read-only

boolean

Whether the field was successfully trained.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

category

"multivalue"

Category of the object.

children

object

Object specifying type of children. It may contain only objects with category datapoint.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

trained

read-only

boolean

Whether the field was successfully trained.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

trained

read-only

boolean

Whether the field was successfully trained.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

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

deprecated

Delete dedicated engine schema

Delete a dedicated engine schema object.

Please note that Dedicated Engine Schema is an internal API and can be changed without notice.

curl -X DELETE "https://example.rossum.app/api/v1/dedicated_engine_schemas/0"

curl -X DELETE "https://example.rossum.app/api/v1/dedicated_engine_schemas/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": "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

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

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

deprecated

Update dedicated engine schema

Update dedicated engine schema object.

Please note that Dedicated Engine Schema is an internal API and can be changed without notice.

curl -X PUT "https://example.rossum.app/api/v1/dedicated_engine_schemas/0" \
  -H "Content-Type: application/json" \
  -d '{
    "content": {}
  }'

curl -X PUT "https://example.rossum.app/api/v1/dedicated_engine_schemas/0" \  -H "Content-Type: application/json" \  -d '{    "content": {}  }'

{
  "id": 6000,
  "url": "https://example.rossum.app/api/v1/dedicated_engine_schemas/6000",
  "content": {
    "training_queues": [
      "https://example.rossum.app/api/v1/queues/123",
      "https://example.rossum.app/api/v1/queues/200",
      "https://example.rossum.app/api/v1/queues/321"
    ],
    "fields": [
      {
        "category": "multivalue",
        "engine_output_id": "line_items",
        "label": "Line Items",
        "trained": true,
        "type": "grid",
        "description": "Line item column types.",
        "children": {
          "category": "tuple",
          "children": [
            {
              "category": "datapoint",
              "engine_output_id": "document_id",
              "label": "Document ID",
              "trained": true,
              "type": "string",
              "description": "Document number",
              "sources": [
                {
                  "queue": "string",
                  "schema_id": "document_id"
                }
              ]
            }
          ]
        }
      }
    ]
  }
}

{
  "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

content*

object

training_queues

list[URL]

List of Queues that will be used for the training. Note that queues can't have delete_after field set, otherwise a validation error is raised.

fields

list[object]

Container for fields declarations. It may contain only objects of category multivalue or datapoint.

category

"multivalue"

Category of the object.

engine_output_id

string

Unique name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

type

"grid" | "freeform"

Type of the trained field.

description

string

Description of field attribute.

children

object

Object specifying type of children. It may contain only objects with category tuple.

category

"tuple"

Category of the object.

children

list[object]

Array specifying objects that belong to a given tuple. It may contain only objects with category datapoint.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

category

"multivalue"

Category of the object.

children

object

Object specifying type of children. It may contain only objects with category datapoint.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

Response

200OK

Attribute

Type

Description

id*

read-only

integer

ID of the engine schema.

url*

read-only

URL

URL of the engine schema.

content*

object

training_queues

list[URL]

List of Queues that will be used for the training. Note that queues can't have delete_after field set, otherwise a validation error is raised.

fields

list[object]

Container for fields declarations. It may contain only objects of category multivalue or datapoint.

category

"multivalue"

Category of the object.

engine_output_id

string

Unique name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

trained

read-only

boolean

Whether the field was successfully trained.

type

"grid" | "freeform"

Type of the trained field.

description

string

Description of field attribute.

children

object

Object specifying type of children. It may contain only objects with category tuple.

category

"tuple"

Category of the object.

children

list[object]

Array specifying objects that belong to a given tuple. It may contain only objects with category datapoint.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

trained

read-only

boolean

Whether the field was successfully trained.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

category

"multivalue"

Category of the object.

children

object

Object specifying type of children. It may contain only objects with category datapoint.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

trained

read-only

boolean

Whether the field was successfully trained.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

trained

read-only

boolean

Whether the field was successfully trained.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

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

deprecated

Predict dedicated engine schema

Try to predict a dedicated engine schema based on the provided training queue's schemas. The predicted schema is not guaranteed to pass /v1/dedicated_engine_schemas/validate check, only the checks done on engine schema save.

Returns 200 and predicted dedicated engine schema.

curl -X POST "https://example.rossum.app/api/v1/dedicated_engine_schemas/predict" \
  -H "Content-Type: application/json" \
  -d '{
    "training_queues": [
      "https://example.rossum.app/api/v1/queues/123",
      "https://example.rossum.app/api/v1/queues/200",
      "https://example.rossum.app/api/v1/queues/321"
    ]
  }'

curl -X POST "https://example.rossum.app/api/v1/dedicated_engine_schemas/predict" \  -H "Content-Type: application/json" \  -d '{    "training_queues": [      "https://example.rossum.app/api/v1/queues/123",      "https://example.rossum.app/api/v1/queues/200",      "https://example.rossum.app/api/v1/queues/321"    ]  }'

{
  "content": {
    "training_queues": [
      "https://example.rossum.app/api/v1/queues/123",
      "https://example.rossum.app/api/v1/queues/200",
      "https://example.rossum.app/api/v1/queues/321"
    ],
    "fields": [
      {
        "category": "multivalue",
        "engine_output_id": "line_items",
        "label": "Line Items",
        "trained": true,
        "type": "grid",
        "description": "Line item column types.",
        "children": {
          "category": "tuple",
          "children": [
            {
              "category": "datapoint",
              "engine_output_id": "document_id",
              "label": "Document ID",
              "trained": true,
              "type": "string",
              "description": "Document number",
              "sources": [
                {
                  "queue": "string",
                  "schema_id": "document_id"
                }
              ]
            }
          ]
        }
      }
    ]
  }
}

{
  "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

training_queues*

list[URL]

List of Queues that will be used for the training.

Response

200OK

Predicted dedicated engine schema

Attribute

Type

Description

content

object

training_queues

list[URL]

List of Queues that will be used for the training. Note that queues can't have delete_after field set, otherwise a validation error is raised.

fields

list[object]

Container for fields declarations. It may contain only objects of category multivalue or datapoint.

category

"multivalue"

Category of the object.

engine_output_id

string

Unique name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

trained

read-only

boolean

Whether the field was successfully trained.

type

"grid" | "freeform"

Type of the trained field.

description

string

Description of field attribute.

children

object

Object specifying type of children. It may contain only objects with category tuple.

category

"tuple"

Category of the object.

children

list[object]

Array specifying objects that belong to a given tuple. It may contain only objects with category datapoint.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

trained

read-only

boolean

Whether the field was successfully trained.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

category

"multivalue"

Category of the object.

children

object

Object specifying type of children. It may contain only objects with category datapoint.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

trained

read-only

boolean

Whether the field was successfully trained.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

trained

read-only

boolean

Whether the field was successfully trained.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

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

deprecated

Validate dedicated engine schema

Validate dedicated engine schema object, check for errors. Additionally, to the basic checks done by the CRUD endpoints, this endpoint checks that:

The declared engine_output_ids are unique across the whole schema
The mapped Queue datapoints (via schema_ids) are of the same type as the declared type
The mapped Queue datapoints of enum type have exactly the same option values declared
Different shapes of datapoints are not mixed together
The mapped Queue datapoints of Multivalue-Tuple fields are of the same grid/freeform type
When mapping to a single Multivalue-Tuple field, all the datapoints mapped from one Queue must come from a single tabular datapoint
Multiple fields do not link to the same Queue Datapoint
A mapped field either maps a Queue Datapoint with null/empty rir_field_names or the engine_output_id matches one of the mapped rir-namespaced rir_field_names (prefixed by rir: or nothing)

Returns 200 and error description in case of validation failure.

curl -X POST "https://example.rossum.app/api/v1/dedicated_engine_schemas/validate" \
  -H "Content-Type: application/json" \
  -d '{
    "content": {}
  }'

curl -X POST "https://example.rossum.app/api/v1/dedicated_engine_schemas/validate" \  -H "Content-Type: application/json" \  -d '{    "content": {}  }'

{}

{
  "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

content*

object

training_queues

list[URL]

List of Queues that will be used for the training. Note that queues can't have delete_after field set, otherwise a validation error is raised.

fields

list[object]

Container for fields declarations. It may contain only objects of category multivalue or datapoint.

category

"multivalue"

Category of the object.

engine_output_id

string

Unique name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

type

"grid" | "freeform"

Type of the trained field.

description

string

Description of field attribute.

children

object

Object specifying type of children. It may contain only objects with category tuple.

category

"tuple"

Category of the object.

children

list[object]

Array specifying objects that belong to a given tuple. It may contain only objects with category datapoint.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

category

"multivalue"

Category of the object.

children

object

Object specifying type of children. It may contain only objects with category datapoint.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

category

"datapoint"

Category of the object.

engine_output_id

string

Name of the new extracted field in the trained Dedicated Engine.

label

string

User-friendly label for an object, shown in the user interface.

type

"number" | "string" | "date" | "enum"

Type of the trained field.

description

string

Description of field attribute.

sources

list[object]

Mapping describing the source Queues and their fields to train this field from.

queue

URL

Queue to map the field from. Only one Queue per engine output is allowed.

schema_id

string

ID of the field to map. The id must exist in the mapped Queue's schema.

Response

200OK

Validation result (success or failure with error description)

responseobject

Validation result object

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