documents

Cancel a document; unstarted work is refunded

post/v1/documents/{document_id}/cancel

Request

  • Base URL: https://www.polytranslator.com/api
  • URL: https://www.polytranslator.com/api/v1/documents/{document_id}/cancel
  • Auth: HTTP bearer

Path parameters

document_idstring uuid required

Response

Successful Response

idstring required
object'document'
status'queued' | 'processing' | 'completed' | 'failed' | 'canceled' required
filenamestring required
formatstring required
srcstring required
tgtstring required
tierstring required
outputstring required
created_atstring date-time required
completed_atstring date-time nullable required
partialboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.