rout.my documentation

rout.my exposes a unified API for chat, embeddings, image generation, video generation, and compatibility formats used by popular clients. The quick-start examples are pre-filled with rout.my defaults so a new user only needs to paste their API key.

Base URLs

Purpose	URL
OpenAI-compatible API	https://api.rout.my/v1
Gemini-compatible API	https://api.rout.my/compatible/v1beta
Anthropic-compatible API	https://api.rout.my/v1
Embed image URLs	https://api.rout.my/embed

Main endpoints

Endpoint	Method	What it does
/v1/models	GET	Lists model IDs visible to your account.
/v1/chat/completions	POST	OpenAI-style chat, tools, vision input, streaming, and image-capable chat models.
/v1/responses	POST	OpenAI Responses-style request shape for agents and Codex-like clients.
/v1/embeddings	POST	Text embeddings for search, retrieval, clustering, and similarity.
/v1/images/generations	POST	OpenAI-style image generation endpoint.
/v1/video/generations	POST	Synchronous video generation endpoint.
/embed/image:{model}	GET	Returns raw image bytes for direct use in HTML or Markdown.

Start here

• Quick Start shows the first request.
• Models explains model IDs and availability.
• API Explorer builds a request and can send it with your own key.
• Endpoint Matrix lists every main route in one table.
• Integrations covers common client setup.
• llms.txt gives agents a compact map of the docs.

Ready defaults

Client or task	Use this model
OpenAI-compatible chat and SDK examples	openai/gpt-5.4
Codex custom provider	openai/gpt-5.4
Cheaper/faster OpenAI-compatible fallback	openai/gpt-5.4-mini
Claude Code and Anthropic SDK	anthropic/claude-sonnet-4.6

Model IDs for advanced users

Use GET /v1/models only when you want a different model. If you change the examples, copy the exact id returned by the API.