Sign in

v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
Documents

Create document

<Warning> **Deprecated** — Removal scheduled for **July 31, 2026**. Use the [Documents v2 API](/api/documents-v2/create-document) instead. </Warning>

Create a new document

post/v1/documents

Request body

modelIdstring uuid required

The ID of the model to build the document on

namestring required

The name of the document

descriptionstring

Description of the document

identifierstring

Custom identifier for the document. If not provided, an identifier will be auto-generated.

The identifier is used in the document's URL and must be unique across all documents in your organization.

Format requirements:

  • Must match the pattern: lowercase letters, numbers, hyphens, and underscores only
  • Cannot start or end with a hyphen or underscore

Note: Once created, the identifier can be changed using the Update document endpoint.

Example request

{
  "identifier": "sales-dashboard-2026"
}

Response

Document created successfully