ROrossum
Dedicated Engine

Retrieve dedicated engine

Changed on

Get a dedicated engine object.

get/api/v1/dedicated_engines/{dedicatedEngineID}

Request

Path parameters

dedicatedEngineIDinteger required

ID of the dedicated engine

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

  • f1b5a910991dRevision changes
    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added subschema #2 to the response body allOf list for the response status