Sign in
Dedicated Engine

Create dedicated engine

Create a new dedicated engine object.

<Callout type="info"> 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. </Callout>
post/api/v1/dedicated_engines

Request body

idinteger

ID of the engine

namestring

Name of the engine

descriptionstring

Description of the engine

urlstring url

URL of the engine

status'draft' | 'schema_review' | 'annotating_initial' | 'annotating_review' | 'annotating_training' | 'training_started' | 'training_finished' | 'retraining' | 'sample_review'

Current status of the engine. If status is not draft, the whole engine and its schema become read-only.

schemastring url nullable

Related dedicated engine schema URL

queuesstring[]

List of queues using this dedicated engine

Example request

{
  "id": 3000,
  "name": "Dedicated engine 1",
  "description": "AI engine trained to recognize data for the specific data capture requirement",
  "url": "https://example.rossum.app/api/v1/dedicated_engines/3000",
  "status": "draft",
  "schema": "https://example.rossum.app/api/v1/dedicated_engine_schemas/6000",
  "queues": []
}

Response

Created

idinteger required

ID of the engine

namestring required

Name of the engine

descriptionstring required

Description of the engine

urlstring url required

URL of the engine

status'draft' | 'schema_review' | 'annotating_initial' | 'annotating_review' | 'annotating_training' | 'training_started' | 'training_finished' | 'retraining' | 'sample_review' required

Current status of the engine. If status is not draft, the whole engine and its schema become read-only.

schemastring url nullable required

Related dedicated engine schema URL

queuesstring[] required

List of queues using this dedicated engine

Example response

{
  "id": 3000,
  "name": "Dedicated engine 1",
  "description": "AI engine trained to recognize data for the specific data capture requirement",
  "url": "https://example.rossum.app/api/v1/dedicated_engines/3000",
  "status": "draft",
  "schema": "https://example.rossum.app/api/v1/dedicated_engine_schemas/6000",
  "queues": []
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.