---
title: "Create dedicated engine"
method: POST
path: "/api/v1/dedicated_engines"
tags: ["Dedicated Engine"]
deprecated: true
---

# Create dedicated engine

`POST /api/v1/dedicated_engines`

> **Deprecated.**

Create a new dedicated engine object.

<Callout type="info">
Talk with a Rossum representative about enabling this feature. You can create new Dedicated Engine objects. However, no Dedicated Engine will be trained unless Dedicated Engines are part of your agreement.
</Callout>

## Request body

- DedicatedEngineBase
  - `id` integer — ID of the engine
  - `name` string — Name of the engine
  - `description` string — Description of the engine
  - `url` string, url — URL of the engine
  - `status` 'draft' | 'schema_review' | 'annotating_initial' | 'annotating_review' | 'annotating_training' | 'training_started' | 'training_finished' | 'retraining' | 'sample_review' — Current status of the engine. If status is not `draft`, the whole engine and its schema become read-only.
  - `schema` string, url, nullable — Related dedicated engine schema URL
  - `queues` string[] — List of queues using this dedicated engine

## Response `201`

Created

- DedicatedEngine
  - `id` integer, required — ID of the engine
  - `name` string, required — Name of the engine
  - `description` string, required — Description of the engine
  - `url` string, 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.
  - `schema` string, url, nullable, required — Related dedicated engine schema URL
  - `queues` string[], required — List of queues using this dedicated engine

## 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
- `413` — Payload too large (especially for files uploaded).
- `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)