createStep
Create a step
Create a step in the API key's organization.
Requires the owner or admin organization role; a member receives 403.
Every code in identification.types must be a document type the organization
can access (its own or a published public one), otherwise the request fails
with 400 and nothing is created.
The internal processing configuration (conversion options, result caching, RAG configs, AI model) is managed by Docutray and cannot be set through this API.
Authorization
ApiKeyAuth Bearer token for API authentication
In: header
Request Body
application/json
Response Body
application/json
identifyDocumentAsync POST
Identify the document type asynchronously from a provided list of options. **Supported file formats:** - image/jpeg (JPEG) - image/png (PNG) - image/gif (GIF) - image/bmp (BMP) - image/webp (WebP) - application/pdf (PDF) **Size limits:** - Maximum file size: 100MB - URL download timeout: 30 seconds **Request methods:** 1. **multipart/form-data**: Direct file upload 2. **application/json with base64**: Base64-encoded image 3. **application/json with URL**: Image URL for automatic download **Async workflow:** 1. Submit document for identification (returns identification_id) 2. Poll `/api/identify-async/status/{id}` for completion 3. Retrieve identified document type when status is SUCCESS
deleteStep DELETE
Permanently delete a step of the API key's organization. Requires the `owner` or `admin` organization role; a `member` receives 403. **This also deletes the step's whole execution history**, which is removed in cascade and cannot be recovered. To stop a step from running without losing its history, set `isActive: false` instead. Deletion is rejected with 409 while the step has executions in flight — uploading, enqueued or in progress. The check is part of the delete statement itself, so an execution submitted while the deletion runs is either counted or rejected, never silently destroyed.