---
title: "Retrieve generic engine"
method: GET
path: "/api/v1/generic_engines/{genericEngineID}"
tags: ["Generic Engine"]
---

# Retrieve generic engine

`GET /api/v1/generic_engines/{genericEngineID}`

Get a generic engine object.

## Response `200`

OK

- GenericEngine
  - `id` integer, required — ID of the generic engine.
  - `url` string, uri, required — URL of the generic engine.
  - `name` string, required — Name of the generic engine.
  - `description` string, required — Description of the generic engine.
  - `documentation_url` string, uri, nullable, required — URL of the generic engine's documentation.
  - `schema` string, uri, nullable, required — URL of the related generic engine 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)