Start Here
Build with AI
Compact, machine-readable Omni contracts for coding agents and LLMs.
Provide your coding assistant (Claude Code, Cursor, Codex, or Windsurf) with the complete, machine-readable Omni contract.
Machine-Readable Resources
| Artifact | Path | Purpose |
|---|---|---|
| Docs Index | /llms.txt | Compact index of all documentation pages for agent discovery. |
| Full Documentation | /llms-full.txt | Single concatenated document for RAG pipelines or high-context models. |
| OpenAPI 3.1 Spec | /openapi.yaml | Complete machine-readable endpoint schema. |
Coding Agent Integration Brief
Paste this prompt directly into your agent's system prompt or workspace context:
# Omni Agent Integration Brief
Omni is an index-grounded agent platform. All developer API calls connect to:
Base URL: https://edge.omnistatic.com
## Authentication
- Header: `Authorization: Bearer <omni_sk_live_...>`
- Verify identity: `GET /v1/me`
- Scopes: `chat` (inference), `memory:read` (retrieve), `memory:write` (store), `usage:read` (credits)
## Core Endpoints
1. `GET /health` -> `{ status: "ok" }`
2. `GET /v1/me` -> `{ ok: true, userId, profile }`
3. `POST /v1/memories` -> `{ content: string, metadata?: object }` -> returns `{ id, content }`
4. `POST /v1/memories/search` -> `{ query: string, top_k?: number }` -> returns semantic matches
5. `POST /v1/context/build` -> `{ query: string, workspace_id?: string }` -> returns `{ contextText, items }`
6. `POST /v1/chat/completions` -> Standard OpenAI chat completions format with streaming SSE support. Relevant memories are automatically retrieved and injected into prompt context.
7. `GET /v1/credits` -> `{ used, limit, remaining, month }`
## Error Handling
- Envelope: `{ "error": { "code": string, "message": string } }`
- Handle `429` (rate limits & quota) with exponential backoff using the `Retry-After` header.
- Never hardcode or print API keys.Connect via MCP (Model Context Protocol)
Connect your local IDE or assistant directly to Omni's documentation and tools via MCP:
claude mcp add --transport http omni-docs https://edge.omnistatic.com/mcp{
"mcpServers": {
"omni-docs": {
"url": "https://edge.omnistatic.com/mcp"
}
}
}{
"servers": {
"omni-docs": {
"type": "http",
"url": "https://edge.omnistatic.com/mcp"
}
}
}