Submit a job

POST/jobs

Queue a long-running job scoped to the linked user + usergroup. The type must be one of the externally-submittable job types; params must carry the resource ref the job operates on plus any per-type options. All usergroup, feature-flag, file-type and permission checks are the same as the in-app path. Requires the write scope.

Supports the Idempotency-Key header: a retry with the same key + body within 24h replays the original response (Idempotent-Replayed: true) instead of queuing a second job. Reusing a key with a different body returns 422 IDEMPOTENCY_KEY_CONFLICT.

Authorization

apiKey

X-Api-Key<token>

Issued to you when your integration is provisioned. Determines which catalogue resources are visible and which AI tools are available.

In: header

Header Parameters

Idempotency-Key?string

Printable-ASCII token that makes a retried submit safe.

Lengthlength <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

type*JobType

Externally-submittable job type. Internal/system job types are not exposed. All are non-destructive — output is written as a new alternative file / child resource / report; the source is never modified.

proofreading — tracked-changes copy (Word) or commented copy (PDF).
translate — translated alternative file. Needs name + language.
adapt — adapted alternative file. Needs name + adaptation_type.
style-coding — style-coded copy. Needs name + profile_id.
corrections-check — verifies a marked-up / 2P pass against the primary; needs a second document (see JobSubmitRequest).
accessibility-check — EPUB accessibility remediation + report.
document-index — back-of-book index. Needs name + type.
scan — AI document analysis report. Needs scan_instructions + scan_summary.

Value in

"proofreading"
"translate"
"adapt"
"style-coding"
"corrections-check"
"accessibility-check"
"document-index"
"scan"

params*

Job parameters. Must include resource (the resource ref the job runs on). Remaining keys are the same options the corresponding in-app action accepts (e.g. name for proofreading, language for translate).

corrections-check additionally requires a SECOND document — either compareResourceRef (another resource visible to you) or compareAltFileRef (an alternative file of the primary resource). A second resource you cannot see returns 404 (not-found and no-access are indistinguishable). The internal temp-upload path is not available on the external API.

Response Body

`application/json`

curl -X POST "https://example.com/jobs" \  -H "Content-Type: application/json" \  -d '{    "type": "proofreading",    "params": {      "resource": 101,      "name": "Copyedit pass",      "ai_comments": true    }  }'

{  "data": {    "jobRef": 555,    "type": "proofreading",    "status": {      "code": 1,      "label": "ready"    }  }}

{  "success": false,  "status": "fail",  "message": "string",  "error": {    "message": "API key is required",    "code": "NO_API_KEY"  }}

{  "success": false,  "status": "fail",  "message": "API key is required",  "error": {    "code": "NO_API_KEY",    "message": "API key is required"  }}

{  "success": false,  "status": "fail",  "message": "This API key does not have the 'write' scope",  "error": {    "code": "INSUFFICIENT_SCOPE",    "message": "This API key does not have the 'write' scope"  }}

{  "success": false,  "status": "fail",  "message": "Idempotency-Key was reused with a different request body",  "error": {    "code": "IDEMPOTENCY_KEY_CONFLICT",    "message": "Idempotency-Key was reused with a different request body"  }}

Authorization

Header Parameters

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

422application/json

Example noApiKey

Example invalidApiKey

Example linkedUserRequired

Example insufficientScope

Example forbidden

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`