Skip to main content
GET
Get a document (status, summary, links when finished)

Authorizations

Authorization
string
header
required

Authorization: Bearer ak_eu_…. The prefix is the project's region and must match the server (api.eu / api.us).

Path Parameters

document_id
string
required

Response

The document.

id
string
required
Pattern: ^doc_[0-9A-HJKMNP-TV-Z]{26}$
object
string
required
Allowed value: "document"
name
string | null
required

The name you gave it (name when creating it).

operation
enum<string>
required
Available options:
create,
review,
edit,
extract
format
enum<string> | null
required

The file you want. docx → Word (with a PDF too), pdf → only the PDF, pptx → PowerPoint (with a PDF), xlsx → Excel (with a PDF). artifact → a web page that keeps data (in each visitor's browser, or shared by everyone), on a signed link; with store: false, a page to download (see the artifacts guide). Without it, Doconda works it out from prompt.

Available options:
docx,
pdf,
pptx,
xlsx,
artifact
type
enum<string> | null
required

What Doconda decided the document is. It sets the default look (a contract: serif, justified, numbered clauses; a letter: no page numbers). You don't choose it: say what you want in prompt, and the look in style.

Available options:
report,
letter,
contract,
memo,
minutes,
presentation,
spreadsheet,
artifact
mode
enum<string> | null
required

manual: a version someone edited by hand in the editor (POST /documents/{id}/versions).

Available options:
prompt,
content,
manual
sector
string | null
required

The professional sector Doconda recognised in the request (legal, healthcare, accounting…). Its guide shapes the structure and conventions; what you say or send always wins.

parent_id
string | null
required

The document this version was edited from.

Pattern: ^doc_[0-9A-HJKMNP-TV-Z]{26}$
status
enum<string>
required
Available options:
queued,
running,
ready,
ready_with_warnings,
needs_review,
failed,
canceled
phase
string | null
required
pages
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
style_applied
object | null
required
style_unsupported
string[]
required
validation_summary
object | null
required
repair_summary
object | null
required
error
object | null
required
versions
object
required
metadata
object
required
store
boolean
required

false: its content is deleted 15 minutes after it finishes.

route
object | null
required

The path Doconda chose to make the file, and why. fast: the AI writes the text and Doconda lays it out (seconds). agent: an AI agent writes the program that builds the file, looks at the pages and fixes them (30 s – 2 min; any design, comments, tracked changes, formulas and charts). Doconda always chooses.

quality
object | null
required

create and edit: the quality level asked for and the one used, which sets the price.

artifact
object | null
required

Artifacts only: where the page keeps its data.

content_deleted_at
string<date-time> | null
required

When its files, request, report and events were deleted (store: false).

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
created_at
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
completed_at
string<date-time> | null
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
outputs
object[]

Present once finished.