OMomni
AI

Search Omni docs

Changed on

Search the Omni documentation using AI to answer questions about Omni features, configuration, modeling, dashboards, and more. Sends a natural language question and returns a synthesized answer with source links to the relevant documentation pages.

post/v1/ai/search-omni-docs

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/ai/search-omni-docs
  • Auth
    • HTTP bearer
    • or HTTP bearer

Request body

questionstring required

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

Example request

{
  "question": "How do I create a dashboard filter?"
}

Response

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

answerstring required

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

Example response

{
  "answer": "To create a dashboard filter, navigate to your dashboard and click the \"Add Filter\" button...\n",
  "sources": [
    {
      "title": "Dashboard Filters",
      "url": "https://docs.omni.co/visualize-present/dashboards/filters"
    }
  ]
}

Changes