Skip to main content
POST
Search Omni docs

Authorizations

Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Body

application/json
question
string
required

A natural language question about Omni features, configuration, modeling, dashboards, or other topics covered in the Omni documentation.

Required string length: 1 - 2000
Example:

"How do I create a dashboard filter?"

Response

Documentation search completed successfully. Returns a synthesized answer with source links.

answer
string
required

A synthesized answer to the question, based on the Omni documentation.

Example:

"To create a dashboard filter, navigate to your dashboard and click the \"Add Filter\" button...\n"

sources
object[]
required

List of documentation pages that were used to synthesize the answer.