API ReferenceSteps

Get step execution status

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

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Bearer token for API authentication

In: header

Path Parameters

executionId*string

Step execution ID returned from the execute step endpoint

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

curl -X GET "https://app.docutray.com/api/steps-async/status/cm5vm9hx30001m5cgh0p9v8qa"

{
  "conversion_id": "cm5vm9hx30001m5cgh0p9v8qa",
  "status": "ENQUEUED",
  "request_timestamp": "2024-01-15T10:30:00.000Z"
}

{
  "message": "Invalid execution ID format"
}

{
  "error": "Invalid API key"
}

{
  "message": "Access denied to this execution"
}

{
  "message": "Execution not found"
}

{
  "error": "Rate limit exceeded",
  "limitType": "minute",
  "limit": 0,
  "remaining": 0,
  "resetTime": 0,
  "retryAfter": 0
}

{
  "message": "Internal server error: Failed to retrieve execution status"
}

Execute a document processing step asynchronously POST

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:** 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 processing (returns execution_id) 2. Poll `/api/steps-async/status/{executionId}` for completion 3. Retrieve extracted data when status is SUCCESS