latestOpenAPI 3.1.02026-08-19211327769.4 KB

e77ab32034c9

Documents

Create document

post/api/v1/documents

Request body

branchIdstring uuid

Optional branch ID to associate the document with a model branch

descriptionstring nullable

Document description

facetFiltersboolean

Enable facet filters on the dashboard

{"stackTrail":"components:schemas:DocumentsCreateBody:properties:filterConfig","oasType":"schema","type":"unknown","description":"Dashboard filter configuration"}

filterOrderstring[]

Order of filters in the dashboard

identifierstring

Optional document identifier. If omitted, an identifier is auto-generated. Must be unique within the organization.

{"stackTrail":"components:schemas:DocumentsCreateBody:properties:metadata","oasType":"schema","type":"unknown","description":"Dashboard metadata"}

metadataVersionstring

Dashboard metadata version (required when metadata is provided)

modelIdstring required

Shared model ID to base the document on

namestring required

Document name

Example request

{
  "branchId": "123e4567-e89b-12d3-a456-426614174001"
}

Response

Document created successfully