Convert File

Convert a document between DOCX and PDF.

POST /api/v1/files/{file_id}/convert

cURL

curl -X POST "https://api.wordsmith.ai/api/v1/files/9a1d7e44-2b6c-4f08-8d3a-71c5e0b9f2a6/convert" \
  -H "Authorization: Bearer sk-ws-api1-your_api_key_here" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: c6a1e9d4-5f2b-4c38-8e07-2d9b4f1a6c73" \
  -d '{ "target_format": "pdf", "wait": 20 }'

Running

{
  "id": "e288a0bd-a8b5-41e0-a128-def91915ff0a",
  "type": "document_action",
  "status": "running",
  "progress": {
    "stage": "convert",
    "completed": 0,
    "total": 1
  },
  "resource": {
    "type": "file",
    "id": "9a1d7e44-2b6c-4f08-8d3a-71c5e0b9f2a6"
  },
  "result": null,
  "error": null,
  "poll_after_seconds": 5,
  "created_at": "2026-10-13T11:00:00Z",
  "updated_at": "2026-10-13T11:00:01Z",
  "completed_at": null
}

Preview. This endpoint is available to organisations in the Wordsmith MCP pilot. Other organisations receive 403 mcp_not_enabled. See the preview overview.

Converts a document to target_format and returns a new file. Use it to turn a DOCX into a PDF for sending, or a PDF into an editable DOCX. A DOC converts to either. Tracked changes in a DOCX show as marked-up text in the PDF. The original file is not changed.

Converting a PDF to DOCX rebuilds the text and layout, so check the result of a complex or scanned PDF.

The action runs as an operation of type document_action: the response comes back straight away, and the work runs in the background. Wait for it with wait, a callback_url, or Get Operation. The new files land in your private space. The input files are not changed. Document actions use no credits.

Authentication

Send an API key, or an OAuth access token with both the files:write and files:read scopes. files:write lets the action create its output; files:read lets it read the inputs. A token without either gets 403 with "error": "insufficient_scope".

Path parameters

file_id · string (uuid) · required

The file to convert: a DOCX, DOC or PDF.

Headers

Idempotency-Key · string

A unique key for this request, such as a UUID, up to 255 characters. A repeat with the same key within 30 days returns 200 with the same operation and does the work once. A repeat with a different body returns 409 idempotency_key_reused.

Body parameters

target_format · string · required

pdf or docx. It must differ from the file’s current format.

wait · integer · default: "0"

Seconds to wait for the action to finish before responding, from 0 to 20. Most conversions finish inside 20.

callback_url · string

A public HTTPS URL that receives a signed operation.succeeded, operation.failed or operation.cancelled event when the action finishes. API keys only: an OAuth caller waits or polls instead.

Response

Returns 202 with an operation of type document_action. Its resource is the input file. A repeat with the same Idempotency-Key returns 200 with the same operation.

When status is succeeded, result is { "action": "convert", "file_ids", "summary" }. file_ids holds one id: the converted file. summary is null.

When status is failed, error.code says why:

error.code	When
resource_not_found	An input was deleted, or your access to it removed, before the work ran.
invalid_document	An input could not be read: it is damaged, password-protected or not a valid DOCX or PDF. Retrying does not help.
action_failed	The action failed for another reason. error.retryable is true: try again.

id · string (uuid)

The operation’s id.

type · string

document_action.

status · string

queued until a worker starts the action, then running, succeeded, failed or cancelled.

progress · object | null

{ "stage", "completed", "total" }. null until the work starts.

resource · object

{ "type": "file", "id" }: the input file.

result · object | null

Set when status is succeeded.

error · object | null

{ "code", "message", "retryable" }, set when status is failed.

poll_after_seconds · integer | null

When to ask again. null once the operation has finished.

created_at · string

ISO 8601 UTC.

updated_at · string

ISO 8601 UTC.

completed_at · string | null

ISO 8601 UTC, once the operation has finished.

cURL

curl -X POST "https://api.wordsmith.ai/api/v1/files/9a1d7e44-2b6c-4f08-8d3a-71c5e0b9f2a6/convert" \
  -H "Authorization: Bearer sk-ws-api1-your_api_key_here" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: c6a1e9d4-5f2b-4c38-8e07-2d9b4f1a6c73" \
  -d '{ "target_format": "pdf", "wait": 20 }'

Running

{
  "id": "e288a0bd-a8b5-41e0-a128-def91915ff0a",
  "type": "document_action",
  "status": "running",
  "progress": {
    "stage": "convert",
    "completed": 0,
    "total": 1
  },
  "resource": {
    "type": "file",
    "id": "9a1d7e44-2b6c-4f08-8d3a-71c5e0b9f2a6"
  },
  "result": null,
  "error": null,
  "poll_after_seconds": 5,
  "created_at": "2026-10-13T11:00:00Z",
  "updated_at": "2026-10-13T11:00:01Z",
  "completed_at": null
}

Errors

Status	error_code	When
400	invalid_request_body	The body is not valid JSON, has an unknown field, or target_format is missing or not pdf or docx.
400	unsupported_file_type	The file is not a DOCX, DOC or PDF, or it is already in target_format.
400	invalid_wait	wait is not from 0 to 20.
400	invalid_callback_url	callback_url is not a public HTTPS URL.
400	callback_signing_unavailable	The API key has no webhook secret to sign the callback with. Create a new API key, or long-poll the operation instead.
400	bad_request	callback_url was sent with an OAuth token.
403	insufficient_scope	The OAuth token lacks files:write or files:read.
403	forbidden	Your user may not upload files, so the output has nowhere to go.
404	resource_not_found	The file does not exist, or you cannot read it.
409	scan_in_progress	The file’s malware scan has not finished. Retry in a few seconds.
409	idempotency_key_reused	The Idempotency-Key was used within 30 days with a different request.