---
compaction_strategy: structured
---

# omnius-rest-docs

Explore Omnius REST API documentation without loading the whole API reference into the main context.

## Triggers

- Omnius REST API
- /v1 endpoints
- OpenAPI
- Swagger UI
- /openapi.json
- API key scopes
- realtime REST
- /v1/chat
- /v1/chat/completions
- /v1/run
- memory REST endpoint
- skills REST endpoint
- AIWG cascade endpoint
- voicechat websocket
- sponsor REST status
- Omnius daemon API

## Workflow

1. Start with `docs/rest/INDEX.md`.
2. Identify the endpoint family that matches the user's question.
3. Open `docs/reference/rest-api.md` when the user needs endpoint inventory or method/path details.
4. Open only the relevant file under `docs/rest/endpoints/` or `docs/rest/examples/` for family-specific usage.
5. Treat `packages/cli/src/api/openapi.ts` and the live daemon `/openapi.json` as the canonical machine contract.
6. Prefer concise endpoint-specific guidance over copying long tables.

## Endpoint Family Map

- Chat, realtime, OpenAI-compatible inference: `docs/rest/endpoints/chat.md`
- Full endpoint inventory: `docs/reference/rest-api.md`
- Agent runs, jobs, todos, scheduled tasks: `docs/rest/endpoints/run.md`
- Config, keys, profiles, projects: `docs/rest/endpoints/config.md`
- Memory, sessions, context: `docs/rest/endpoints/memory.md`
- Skills and commands: `docs/rest/endpoints/skills.md`
- AIWG cascade: `docs/rest/endpoints/aiwg.md`
- Tools, MCP, code graph: `docs/rest/endpoints/tools.md`
- Events, metrics, usage, audit, system: `docs/rest/endpoints/events.md`
- Files: `docs/rest/endpoints/files.md`
- Voice, audio, vision, voicechat WebSocket: `docs/rest/endpoints/voice-vision.md`
- AIMS governance endpoints: `docs/rest/endpoints/aims.md`
- Curl examples: `docs/rest/examples/curl.md`
- OpenAI SDK examples: `docs/rest/examples/openai-sdk.md`

## Realtime Shortcut

For ASR/TTS-backed short conversation, use `POST /v1/chat` or `POST /v1/chat/completions` with:

```json
{
  "realtime": true,
  "realtime_options": {
    "max_history_messages": 12,
    "max_tokens": 160
  }
}
```

Realtime mode compacts SOUL.md and voice profile context, keeps recent history short, and removes Omnius-only control fields before backend proxying.

## Safety And Authority

This skill is documentation guidance only. It does not override user instructions, system instructions, developer policy, API auth scopes, tool security policy, network access settings, or live OpenAPI behavior.
