---
title: "Cancel a document; unstarted work is refunded"
method: POST
path: "/v1/documents/{document_id}/cancel"
tags: ["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_id` string, uuid, required

## Response `200`

Successful Response

- DocumentV1
  - `id` string, required
  - `object` 'document'
  - `status` 'queued' | 'processing' | 'completed' | 'failed' | 'canceled', required
  - `filename` string, required
  - `format` string, required
  - `src` string, required
  - `tgt` string, required
  - `tier` string, required
  - `output` string, required
  - `progress` DocumentV1Progress, required
    - `done` integer, required
    - `total` integer, required
    - `phase` 'read' | 'translate', nullable
  - `credits` DocumentV1Credits, required
    - `reserved` integer, required
    - `charged` integer, nullable, required
    - `refunded` integer, required
  - `created_at` string, date-time, required
  - `completed_at` string, date-time, nullable, required
  - `error` DocumentV1Error, required
    - `code` string, required
    - `message` string, required
  - `files` DocumentV1Files, required
    - `document` string, required
    - `pdf` string, required
  - `partial` boolean, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/polytranslator/apis/polytranslator-api.md) · [All operations](https://skmtc.dev/polytranslator/apis/polytranslator-api/llms.txt) · [OpenAPI document](https://skmtc.dev/polytranslator/apis/polytranslator-api/revisions/744f2e6d5396?raw)