executeStepAsync
Execute a document processing step asynchronously
Process documents using the specified Step configuration asynchronously.
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:
- multipart/form-data: Direct file upload
- application/json with base64: Base64-encoded image
- application/json with URL: Image URL for automatic download
Async workflow:
- Submit document for processing (returns execution_id)
- Poll
/api/steps-async/status/{executionId}for completion - Retrieve extracted data when status is SUCCESS
Authorization
ApiKeyAuth Bearer token for API authentication
In: header
Path Parameters
Step ID for processing
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
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.
getStep GET
Retrieve a step belonging to the API key's organization, including its execution counters. Requires membership in that organization; any role (`owner`, `admin`, `member`) can read. A step from another organization is indistinguishable from a non-existent one: both return 404.