# XRoute ## Docs ### Overview - [Welcome to XRoute](https://docs.xroute.ai/index.md): One API key for all your LLMs, Image models, and Video models, with pay-per-use billing. - [Welcome to XRoute](https://docs.xroute.ai/guides.md): One API key for all your LLMs, Image models, and Video models, with pay-per-use billing. - [How XRoute Works](https://docs.xroute.ai/how-it-works.md): Learn how authentication, unified endpoints, and pay-per-use billing work together in one request path. ### Get Started · For Developers - [Quickstart: API Key & First Call](https://docs.xroute.ai/quickstart.md): Get your XRoute API key, make your first model call (text, image, video), and monitor usage in minutes. - [SDK Compatibility](https://docs.xroute.ai/get-started/sdk-compatibility.md): Learn how to integrate XRoute seamlessly with official OpenAI, Anthropic, Google GenAI, and Byteplus Ark SDKs, as well as open-source frameworks. ### XRoute Console - [XRoute Console Overview](https://docs.xroute.ai/console/overview.md): Explore the XRoute Personal Console: monitor balance, manage API credentials, configure failover policies, and inspect real-time call logs. - [Personal Dashboard](https://docs.xroute.ai/console/dashboard.md): Monitor resource usage, copy pre-configured API call commands, and inspect recent call details. - [Access Credentials](https://docs.xroute.ai/console/credentials.md): Create and manage system access keys, copy secret tokens, and control resource authorization scopes. - [Account Balance & Top-Up](https://docs.xroute.ai/console/balance.md): View available credit balance, top up online, analyze daily consumption records, and view top-spending models. - [Voucher Assets](https://docs.xroute.ai/console/voucher.md): Redeem promotional voucher codes and manage voucher credits deducted prior to cash balance. - [Accessible Resources](https://docs.xroute.ai/console/resources.md): Browse all LLMs, multimodal models, and providers authorized to your account and resource groups. - [Model Mapping Policy & Disaster Recovery](https://docs.xroute.ai/console/model-mapping.md): Configure custom request aliases, provider parameter templates, and automated disaster recovery failover rules. - [Call Statistics & Audit Logs](https://docs.xroute.ai/console/call-statistics.md): Monitor global model invocation traffic, latency distributions, success rates, token usage, and per-request audit logs. - [Notifications and Announcements](https://docs.xroute.ai/console/notifications.md): Review system announcements, maintenance notices, and channel distribution application reviews. ### Help - [Frequently Asked Questions](https://docs.xroute.ai/guides/faq.md): Common questions about XRoute: connecting agents, OpenAI and Anthropic compatibility, billing, models, Skills, and data handling. - [Changelog](https://docs.xroute.ai/guides/changelog.md): Release history and product evolution of the XRoute platform: unified AI resource portal, trading & multi-tier distribution, policy management, dashboards, multimodal playground, coupons, and Agent invocation. ## Resources ### Models - [Models Overview & Catalog](https://docs.xroute.ai/resources/models/overview.md): Explore 60+ AI models aggregated on XRoute across Text, Image, and Video modalities with unified and native routing protocols. - [Text Models (LLMs)](https://docs.xroute.ai/resources/models/text.md): Call frontier LLMs like GPT-5.6, Claude Fable, Gemini Pro, and DeepSeek via OpenAI unified, Anthropic unified, or provider native endpoints. - [Image Models (Native Protocols)](https://docs.xroute.ai/resources/models/image.md): Generate and edit images using vendor-native endpoints on XRoute for OpenAI, Google GenAI, Byteplus Ark, and Qwen. - [Video Models (Native Async Tasks)](https://docs.xroute.ai/resources/models/video.md): Generate cinematic AI videos using asynchronous task creation and status polling via Byteplus Seedance and WAN on XRoute. ## Agent Skills (Coming Soon) ### Overview - [Agent Skills](https://docs.xroute.ai/agent-skills.md): Ready-made task instruction bundles for AI coding agents — coming soon. ## Examples ### Use Cases - [Build a Research Agent with XRoute](https://docs.xroute.ai/use-cases/research-agent.md): Give your agent live web, academic, and citation-backed search through XRoute, then synthesize a source-backed brief. - [Build a Market Intelligence Agent with XRoute](https://docs.xroute.ai/use-cases/market-intelligence-agent.md): Combine real-time equity prices, crypto feeds, and prediction market odds into an automated market brief. - [Build a Sales Research Agent with XRoute](https://docs.xroute.ai/use-cases/sales-research-agent.md): Enrich target accounts with web traffic, SEO footprint, and executive signals in one agent workflow. - [Build a Social Intelligence Agent with XRoute](https://docs.xroute.ai/use-cases/social-intelligence-agent.md): Track product launches, developer sentiment, and creator discussions across X and YouTube. - [Design an Autonomous API Purchasing Workflow](https://docs.xroute.ai/use-cases/autonomous-api-purchasing.md): Let agents discover endpoints, quote costs, and execute within strict USD budget guardrails. ## API Reference ### Overview - [API Reference](https://docs.xroute.ai/api-reference.md): One key, one base URL (https://api.xroute.ai), every API. Browse every model and data endpoint XRoute routes to. - [Credit Balance](https://docs.xroute.ai/api-reference/credits-balance.md): Check your account's remaining prepaid Credits and active key limits. - [Account Usage](https://docs.xroute.ai/api-reference/account-usage.md): Query aggregated token usage, call counts, and settled spend across a time window. ### Endpoints - [Chat Completions](https://docs.xroute.ai/api-reference/chat-completions.md): Send conversational requests via XRoute with full support for OpenAI unified, Anthropic unified, and provider native invocation formats. - [List Models](https://docs.xroute.ai/api-reference/models-list.md): List all currently available models and pricing metadata via GET https://api.xroute.ai/v1/models. > The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages. ## Indexes - [Chinese (31 pages)](https://docs.xroute.ai/_llms/zh.txt): 文档, 资源目录, Agent Skills（敬请期待）, 示例场景, API 参考. - [Japanese (31 pages)](https://docs.xroute.ai/_llms/ja.txt): ドキュメント, リソース, Agent Skills（近日公開）, 活用事例, API リファレンス. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.