---
title: "Retrieve generic engine schema"
method: GET
path: "/api/v1/generic_engine_schemas/{genericEngineSchemaID}"
tags: ["Generic Engine Schema"]
---

# Retrieve generic engine schema

`GET /api/v1/generic_engine_schemas/{genericEngineSchemaID}`

Get a generic engine schema object.

**Internal API Warning**: Please note that Generic Engine Schema is an internal API and can be changed without notice.

## Path parameters

- `genericEngineSchemaID` integer, required

## Response `200`

OK

- GenericEngineSchema
  - `id` integer, required — ID of the generic engine schema.
  - `url` string, uri, required — URL of the generic engine schema.
  - `content` EngineContent, required
    - `training_queues` string[] — List of Queues that will be used for the training. Note that queues can't have `delete_after` field set, otherwise a validation error is raised.
    - `fields` Field[] — Container for fields declarations. It may contain only objects of category `multivalue` or `datapoint`.
      - union — Field object that can be either multivalue (with tuple or datapoint children) or datapoint category.
        - MultivalueWithTuple
          - `category` 'multivalue' — Category of the object.
          - `engine_output_id` string — Unique name of the new extracted field in the trained Dedicated Engine.
          - `label` string — User-friendly label for an object, shown in the user interface.
          - `trained` boolean — Whether the field was successfully trained.
          - `type` 'grid' | 'freeform' — Type of the trained field.
          - `description` string — Description of field attribute.
          - `children` EngineTuple
            - `category` 'tuple' — Category of the object.
            - `children` EngineDatapoint[] — Array specifying objects that belong to a given tuple. It may contain only objects with category `datapoint`.
              - …
        - MultivalueWithDatapoint
          - `category` 'multivalue' — Category of the object.
          - `children` EngineDatapoint
            - `category` 'datapoint' — Category of the object.
            - `engine_output_id` string — Name of the new extracted field in the trained Dedicated Engine.
            - `label` string — User-friendly label for an object, shown in the user interface.
            - `trained` boolean — Whether the field was successfully trained.
            - `type` 'number' | 'string' | 'date' | 'enum' — Type of the trained field.
            - `description` string — Description of field attribute.
            - `sources` Source[] — Mapping describing the source Queues and their fields to train this field from.
              - …
        - EngineDatapoint
          - `category` 'datapoint' — Category of the object.
          - `engine_output_id` string — Name of the new extracted field in the trained Dedicated Engine.
          - `label` string — User-friendly label for an object, shown in the user interface.
          - `trained` boolean — Whether the field was successfully trained.
          - `type` 'number' | 'string' | 'date' | 'enum' — Type of the trained field.
          - `description` string — Description of field attribute.
          - `sources` Source[] — Mapping describing the source Queues and their fields to train this field from.
            - `queue` string, uri — Queue to map the field from. Only one Queue per engine output is allowed.
            - `schema_id` string — ID of the field to map. The id must exist in the mapped Queue's schema.

## Other responses

- `400` — Invalid input data.
- `401` — The username/password is invalid or token is invalid (e.g. expired).
- `403` — Insufficient permission, missing authentication, invalid CSRF token and similar issue.
- `404` — The specified resource was not found.
- `409` — Conflict
- `429` — Request rate is too high, wait before sending more requests. See [Rate Limiting](/guides/overview#rate-limiting) for more details.
- `500` — Server failure while processing the request.
- `502` — Invalid response from the upstream server.
- `503` — We're temporarily offline for maintenance. Please try again later.
- `504` — Upstream server could not complete the request in time.

---

[API](https://skmtc.dev/rossum/apis/rossum-api.md) · [All operations](https://skmtc.dev/rossum/apis/rossum-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/rossum/rossum-api/revisions/f1b5a910991d/schema)