Reference

`new Doconda(options?)`

apiKey, baseUrl, maxRetries, fetch. See get started.

`doconda.documents`

Method	Returns
`create(body, { idempotencyKey?, signal? })`	`Document`	Creates, reviews or edits, and waits for it to finish.
`createInBackground(body, options?)`	`Document`	Responds immediately (`status: "queued"`).
`stream(body, options?)`	`AsyncGenerator<DocumentEvent>`	Creates and yields its events live.
`wait(id, { signal? })`	`Document`	Waits for it to finish.
`get(id)`	`Document`	Its current state.
`list({ status? })`	`AsyncGenerator<Document>`	All of them, newest first.
`page({ limit?, cursor?, status? })`	`{ data, next_cursor }`	A single page.
`events(id, { after?, signal? })`	`AsyncGenerator<DocumentEvent>`	Its events, resumable.
`cancel(id)`	`Document`	Stops it if it has not finished yet.
`outputs(id, { expiresIn? })`	`Output[]`	Download links (and an artifact’s page).
`download(id, kind)`	`Uint8Array`	Downloads `docx`, `pdf`, `pptx`, `xlsx`…
`report(id)`	`Report`	Issues, fixes and changes.
`data(id)` / `data(id, collection)`	collections / records	An artifact’s data.

The body is the same as for POST /documents, without stream or background.

`doconda.files`

Method	Returns
`upload(file, filename)`	`DocondaFile`	`Blob`, `File` or bytes (`Uint8Array`, `Buffer`).
`get(id)`	`DocondaFile`	Its details.
`delete(id)`	—	Deletes it.

`DocondaError`

status, code, message, errors, requestId. See errors and retries.

Types

Document, DocumentEvent, Output, Report, ArtifactRecord and CreateDocumentBody are exported from @doconda/sdk: they are the same ones the API uses to validate each request.

Get started

Guides

Reference

`new Doconda(options?)`

`doconda.documents`

`doconda.files`

`DocondaError`

Types

​new Doconda(options?)

​doconda.documents

​doconda.files

​DocondaError

​Types

`new Doconda(options?)`

`doconda.documents`

`doconda.files`

`DocondaError`

Types