---
title: "Check engine template schema compatibility"
method: POST
path: "/api/v1/engines/{engineID}/check_template_compatibility"
tags: ["Engine"]
---

# Check engine template schema compatibility

`POST /api/v1/engines/{engineID}/check_template_compatibility`

This endpoint checks whether the schema on the queue of the template organization whose name is provided in the request body is compatible with this engine. See available templates in [organization](/api/organization#create-organization).

## Path parameters

- `engineID` integer, required

## Request body

- TemplateCompatibilityRequest
  - `name` string, required — Name of the template organization.

## Response `200`

OK

- TemplateCompatibilityResponse
  - `compatible` boolean — Is the template schema compatible with this 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)