Prerequisites
- API key (API keys)
- Channel ID as
queueId(Channels) - Document type mapped to an agent on that channel
Upload
POST /api/v1/queues/{queueId}/files with multipart field files (repeat for multiple files). Optional form fields: documentTypeKey, documentCount.
Response 202 includes queueId, optional batchId, and fileIds.
Try it in the API reference: Upload files.
Get results
- Poll list/get document endpoints until status is Ready, or
- Subscribe to webhooks for Document ready / Document failed