DocuTray
API ReferenceDocuTray.com
API ReferenceConversion

getConversionStatus

Check asynchronous conversion status

GET/api/convert-async/status/{id}

Poll the current status and retrieve the extracted result of an asynchronous document conversion by its ID.

Status flow:

  • ENQUEUED → PROCESSING → SUCCESS | ERROR

Polling recommendations:

  • Poll every 2-3 seconds for active conversions
  • Stop polling when status is SUCCESS or ERROR
  • Maximum processing time: 60 minutes (auto-timeout)

Authorization

ApiKeyAuth
AuthorizationBearer <token>

Bearer token for API authentication

In: header

Path Parameters

id*string

Unique conversion ID to check

Response Body

application/json

application/json

application/json

application/json

application/json

convertDocumentAsync POST

Process documents asynchronously and extract structured data using AI-powered OCR. **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 conversion_id) 2. Poll `/api/convert-async/status/{id}` for completion 3. Retrieve extracted data when status is SUCCESS

createDocumentType POST

Create a new document type with a JSON schema, extraction hints, and validation rules for the OCR pipeline. **Non-admin users:** - `isPublic` is forced to `false` - `source` is set to `USER` - `codeType` must be prefixed with the organization slug (e.g., `orgname_my_type`) - At least 3 characters required after the prefix **Admin users:** - Can set `isPublic` to `true` - `source` defaults to `ADMIN` - No prefix requirement on `codeType`