Sign in
Dedicated Engine

Update dedicated engine

Update dedicated engine object.

<Callout type="info"> If status is not `draft`, the whole engine and its schema become read-only. </Callout>
put/api/v1/dedicated_engines/{dedicatedEngineID}

Path parameters

dedicatedEngineIDinteger required

ID of the dedicated engine

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

OK

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.