Base URL
All API requests should be made to:Response Format
All responses are returned in JSON format. A typical response structure looks like this:Error Handling
The API uses conventional HTTP response codes to indicate the success or failure of requests:2xx
: Success4xx
: Client errors5xx
: Server errors
Document Processing Flow
- Upload: Submit your document using the
/documents/
endpoint - Processing: The document enters our processing pipeline
- Status Check: Poll the document status using the
/documents/{id}
endpoint - Download: Once completed, retrieve the processed content using the provided
output_file_url
Webhooks
You can provide a callback_url parameter when uploading documents. We will notify you when we have finished processing the document by POSTing the document JSON object to the URL provided.Support
If you need help with the API:- Email: support@doctly.ai
- GitHub Issues: github.com/doctly/doctly/issues