OMomniapp
AI

Search Omni documentation

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/api/v1/ai/search-omni-docs

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v1/ai/search-omni-docs
  • Auth
    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 result. Check the status field for complete, partial, skipped, or failed outcomes.

answerstring required

An answer based on the available documentation, or an explanation when the search was skipped or failed.

fulfillmentNotesstring[]

Selected pages that could not be fetched, with each page URL and its HTTP status or transport error code.

status'complete' | 'partial' | 'skipped' | 'failed' required

Search outcome: complete when all selected pages were fetched and an answer was synthesized; partial when some fetches failed but an answer was synthesized; skipped when no usable relevant pages were selected; failed when the index or all selected pages could not be fetched, or the synthesis response could not be parsed.

Example response

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

Changes

  • bb4f102b5d25Revision changes
    • info

      added the non-success response with the status

  • a5501063f4bdRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status