Python SDK
API reference for the DocuTray Python SDK
This is the API reference for the DocuTray Python SDK.
Installation
pip install docutrayModules
Client
The main entry points for the SDK:
Client- Synchronous clientAsyncClient- Asynchronous client
Exceptions
Error handling classes:
Resources
API resource classes:
- Convert - Document conversion
- Identify - Document identification
- DocumentTypes - Document type catalog
- Steps - Step execution
- KnowledgeBases - Knowledge base operations
Types
Response and model types:
Get step execution status 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
Client
Synchronous and asynchronous client classes for the DocuTray API