Sign in

v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB
documents

Create or Update Document

Create a new document on a session (omit document_id → 201), or update an existing one (include document_id → 200) — for example to save a doctor's edits to generated notes. Every response includes a presigned PUT URL: upload the document content (markdown) to that URL to store it.

post/voice/api/v1/documents

Request body

session_idstring required

The session this document belongs to.

document_idstring

Omit to create a new document; include to update an existing one.

template_idstring

Template the document is associated with, if any.

type'context' | 'transcript' | 'custom' | 'notes' | 'integration'

Document category.

document_namestring

Human-readable document name.

statusstring

Document status, e.g. in-progress or success.

usage_informationobject

Example request

{
  "session_id": "ses_abc123def456"
}

Response

Document created (also 200 when updating an existing document)

statusstring

Example response

{
  "status": "success",
  "data": {
    "type": "markdown",
    "status": "success"
  }
}