Skip to main content
POST
/
v1
/
documents
Create document
curl --request POST \
  --url https://{instance}.omniapp.co/api/v1/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "modelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "queryPresentations": [
    {
      "name": "<string>",
      "description": "<string>",
      "query": {},
      "visConfig": {}
    }
  ]
}
'
{
  "dashboard": {},
  "workbook": {}
}

Authorizations

Authorization
string
header
required

Use either an Organization API Key or Personal Access Token (PAT). Include in the Authorization header as: Bearer YOUR_TOKEN

Body

application/json
modelId
string<uuid>
required

Model identifier

name
string
required

Document name

queryPresentations
object[]

Array of query objects

Response

Document created successfully

dashboard
object
workbook
object