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
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
getStepExecutionStatus GET
Retrieves the current status and results of a step execution with standardized response format. **Status values:** - `ENQUEUED`: Request received, waiting to be processed - `PROCESSING`: Currently being processed - `SUCCESS`: Processing completed successfully - `ERROR`: Processing failed **Polling recommendation:** - Poll every 1-2 seconds for small documents - Poll every 3-5 seconds for large documents or PDFs