---
title: "Search Omni docs"
method: POST
path: "/v1/ai/search-omni-docs"
tags: ["AI"]
---

# Search Omni docs

`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: one of:
  - HTTP bearer
  - HTTP bearer

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.

## Request body

- object
  - `question` string, required: A natural language question about Omni features, configuration, modeling, dashboards, or other topics covered in the Omni documentation.

## Response `200`

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

- object
  - `answer` string, required: A synthesized answer to the question, based on the Omni documentation.
  - `sources` object[], required: List of documentation pages that were used to synthesize the answer.
    - `title` string, required: The title of the source documentation page.
    - `url` string, uri, required: URL of the source documentation page.

## Other responses

- `400`: Invalid request. The question may be missing or exceed the 2000 character limit.
- `401`: Missing or invalid API key.
- `402`: AI is unavailable because the organization, the acting user, or that user's embed entity is over its AI credit limit. The body carries the stable reason code `shutoff`.
- `403`: Omni Agent is not enabled for this organization.
- `500`: AI service error.

## Changes

- **2026-11-03** `43290040f88f`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/omni/apis/omni-api/changes/v1/ai/search-omni-docs/post.md)

---

[API](https://skmtc.dev/omni/apis/omni-api.md) - [All operations](https://skmtc.dev/omni/apis/omni-api/llms.txt) - [OpenAPI document](https://skmtc.dev/omni/apis/omni-api/revisions/43290040f88f?raw)