ROrossum
Generic Engine

Retrieve generic engine

Changed on

Get a generic engine object.

get/api/v1/generic_engines/{genericEngineID}

Request

Response

OK

idinteger required

ID of the generic engine.

urlstring uri required

URL of the generic engine.

namestring required

Name of the generic engine.

descriptionstring required

Description of the generic engine.

documentation_urlstring uri nullable required

URL of the generic engine's documentation.

schemastring uri nullable required

URL of the related generic engine schema.

Example response

{
  "id": 3000,
  "url": "https://example.rossum.app/api/v1/generic_engines/3000",
  "name": "Generic engine",
  "description": "AI engine trained to recognize data for the specific data capture requirement",
  "documentation_url": "https://knowledge-base.rossum.ai/docs/ai-engines#generic-engines",
  "schema": "https://example.rossum.app/api/v1/generic_engine_schemas/6000"
}

Changes

  • f1b5a910991dRevision changes
    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status