Sign in
Engine

List engines

Retrieve all engine objects.

get/api/v1/engines

Query parameters

page_sizeinteger

Number of results per page

cursorstring

A value used for cursor-based pagination. Obtain this value from the next or previous URLs in a paginated response. Do not construct cursor values manually.

idinteger[]

Object ID(s) filter

type'extractor' | 'splitter'

Type of the engine to filter by

agenda_idstring

Agenda ID of the engine to filter by

ordering'id' | '-id' | 'type' | '-type' | 'agenda_id' | '-agenda_id'

Result ordering.

Response

OK

Example response

{
  "results": [
    {
      "id": 3,
      "url": "https://example.rossum.app/api/v1/engines/8",
      "name": "Engine name",
      "type": "extractor",
      "learning_enabled": true,
      "description": "AI engine trained to recognize data for the specific data capture requirement",
      "agenda_id": "ross_a9d9vkl1",
      "organization": "https://example.rossum.app/api/v1/organizations/406",
      "training_queues": [
        "https://example.rossum.app/api/v1/queues/8199",
        "https://example.rossum.app/api/v1/queues/8236"
      ],
      "settings": {
        "use_case": "generic_ap"
      }
    }
  ]
}

Changes

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