> ## Documentation Index
> Fetch the complete documentation index at: https://docs.openlit.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> OpenAPI specification for API Endpoints in OpenLIT

<CardGroup cols={2}>
  <Card title="Prompt Hub API" icon="message" href="/latest/openlit/developer-resources/api-reference/endpoint/prompt-hub/get" />

  <Card title="Vault API" icon="vault" href="/latest/openlit/developer-resources/api-reference/endpoint/vault/get" />

  <Card title="Rule Engine API" icon="sliders" href="/latest/openlit/developer-resources/api-reference/endpoint/rule-engine/evaluate" />

  <Card title="Manage Models API" icon="cube" href="/latest/openlit/developer-resources/api-reference/endpoint/manage-models/models" />
</CardGroup>

## Product surfaces

In addition to the SDK-facing endpoints above, the OpenLIT client ships an interactive OpenAPI reference at **Settings → OpenAPI Spec** (`/openapi-spec`). That catalog also covers:

* **AI Analysis** — `GET`/`POST /api/chat/improvement/{spanId}` for saved runs and streaming reviews of traces/spans
* **Ask Otter** — `/api/chat/*` for config, conversations, streaming messages, SQL execute, widgets, and usage
* **Telemetry** — logs, metrics, traces, exceptions, and span hierarchy APIs

See [AI Analysis](/latest/openlit/observability/telemetry/ai-analysis) and [Chat with Otter](/latest/openlit/chat/overview) for product docs.

## Request context headers

OpenLIT scopes data by **Organisation → Project → Environment**. **Signal routing** (latest) picks the connector for each signal from the active project + environment.

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
Authorization: Bearer <openlit-api-key>
x-openlit-organisation-id: <organisation-id>
x-openlit-project-id: <project-id>
x-openlit-environment: production
```

### Non-SDK APIs (telemetry, Ask Otter, AI Analysis, …)

Use signal routing headers only. Do **not** send `x-openlit-database-config-id`. The API key still binds a vault/credential database config (middleware injects `x-database-config-id`).

### SDK-facing APIs (Prompt Hub, Vault, Rule Engine)

Prefer signal routing (`project` + `environment`) to resolve the intelligence ClickHouse that stores prompts, secrets, and rules. Existing SDKs that only send `Authorization: Bearer …` keep working via the API key's bound database config. Those endpoints also accept an explicit `x-openlit-database-config-id` when it belongs to the same project as the key.

## Authentication

All documented endpoints require an Authorization header:

```yaml theme={"theme":{"light":"github-light","dark":"github-dark"}}
Authorization: Bearer <api-key>
```

[Manage Models](/latest/openlit/developer-resources/api-reference/endpoint/manage-models/models) UI pages also accept a signed-in OpenLIT session in the browser. The [public pricing export](/latest/openlit/developer-resources/api-reference/endpoint/manage-models/public-pricing) requires no auth.
