# OptimAI Router Documentation

> Build with open models through one OpenAI-compatible text chat API.

Use the focused pages below for integration work. The complete documentation is available at https://router.optimai.network/llms-full.txt. Model availability and free capacity are live state, so query `GET /v1/models` before sending a request.

- **Getting started**
- [Router Documentation](https://router.optimai.network/docs/index.md): Build with open models through one familiar API. Explore the guides, choose your model, and make your first connection.
- [Make your first request](https://router.optimai.network/docs/quickstart.md): Create an API key, choose a model, and connect your application in a few clear steps.
- [Authentication & API keys](https://router.optimai.network/docs/authentication.md): Connect your application with an account-owned Router API key.
- [How Router works](https://router.optimai.network/docs/how-router-works.md): Follow a request from your application to an available provider and back.
- [OpenAI compatibility](https://router.optimai.network/docs/openai-compatibility.md): Understand the supported OpenAI-style surface and the features that remain outside it.

- **Guides**
- [Models & availability](https://router.optimai.network/docs/models-and-availability.md): Choose an API edition and understand when the network can serve it.
- [Choosing a provider](https://router.optimai.network/docs/choosing-a-provider.md): Use Auto routing or choose a published computer and model offer at a price you have reviewed.
- [Design chat messages](https://router.optimai.network/docs/message-design.md): Build clear text conversations within Router's supported message and context limits.
- [Stream a response](https://router.optimai.network/docs/streaming.md): Read text as it arrives and handle interruptions explicitly.
- [Retries, timeouts & cancellation](https://router.optimai.network/docs/retries-and-timeouts.md): Recover from temporary failures without duplicating uncontrolled work.
- [Usage & observability](https://router.optimai.network/docs/usage-and-observability.md): Read request outcomes, latency, and provider-reported token measurements.
- [Security & privacy](https://router.optimai.network/docs/security-and-privacy.md): Protect API keys and understand the current provider trust boundary.
- [Errors & limits](https://router.optimai.network/docs/errors-and-limits.md): Make failures understandable and give your application a useful recovery path.

- **SDK recipes**
- [cURL](https://router.optimai.network/docs/sdk/curl.md): Inspect Router requests and responses directly from a terminal.
- [Python](https://router.optimai.network/docs/sdk/python.md): Connect the OpenAI Python client to Router and handle a complete response or stream.
- [TypeScript](https://router.optimai.network/docs/sdk/typescript.md): Use the OpenAI JavaScript client with Router in a server-side application.

- **API reference**
- [List models](https://router.optimai.network/docs/api/models.md): Retrieve enabled Router model editions, enforced limits, and observed provider counts.
- [Chat completions](https://router.optimai.network/docs/api/chat-completions.md): Generate a text response with a specific model, or stream the answer as it arrives.
- [Providers](https://router.optimai.network/docs/api/providers.md): Discover public offers and manage your account's provider profile, avatar, and offer publication.
- [Error responses](https://router.optimai.network/docs/api/errors.md): Parse the common Router error envelope and recover according to status and code.

- **Providers**
- [Bring your model to the network](https://router.optimai.network/docs/providers/getting-started.md): Use Core Node to participate as a provider, with explicit control over serving.
- [Readiness & states](https://router.optimai.network/docs/providers/readiness-and-states.md): Understand what Router observes about an enrolled provider computer.
- [Serving controls](https://router.optimai.network/docs/providers/sharing-controls.md): Choose what a computer serves and stop participation when you need to.
- [Public profiles & offers](https://router.optimai.network/docs/providers/public-profiles-and-offers.md): Publish a provider identity and individual computer/model offers while keeping Serving under separate control.
- [Performance & history](https://router.optimai.network/docs/providers/performance-and-history.md): Read provider attempts, completion outcomes, latency, and reported usage without treating estimates as earnings.
- [Provider troubleshooting](https://router.optimai.network/docs/providers/troubleshooting.md): Restore an enrolled computer from offline, connecting, paused, or repeated-failure states.