# XXXRouter

> API documentation. Demonstration environment; production integration acceptance is pending.

## API

- [OpenAPI](/openapi.json): Machine-readable inference contract.

## en

- [Quickstart](/docs/en/quickstart.md): Make your first authenticated request.
- [Authentication](/docs/en/auth.md): Bearer keys, safe storage, and key rotation.
- [Models & pricing](/docs/en/models.md): Capabilities, execution modes, and effective prices.
- [Chat completions](/docs/en/chat.md): OpenAI-style chat requests and SSE streaming.
- [Image generation](/docs/en/images.md): Synchronous results and asynchronous image tasks.
- [Video generation](/docs/en/videos.md): Submit and monitor video tasks.
- [Tasks & idempotency](/docs/en/tasks.md): Poll accepted work without submitting it twice.
- [Balance & billing](/docs/en/billing.md): Prepaid dollars, holds, settlement, and payment status.
- [API key controls](/docs/en/keys.md): Spending limits, expiration, restrictions, and usage attribution.
- [Errors & limits](/docs/en/errors.md): Stable error codes and actionable recovery.
- [Production checklist](/docs/en/production.md): Timeouts, reconciliation, logging, and release gates.
- [Reference URLs & temporary inputs](/docs/en/uploads.md): External reference URLs and temporary Playground uploads.
- [Python integration](/docs/en/python.md): Runnable chat, image and video clients with explicit recovery rules.
- [TypeScript / Node.js integration](/docs/en/typescript.md): Runnable chat, image and video clients with explicit recovery rules.
- [Go integration](/docs/en/go.md): Runnable chat, image and video clients with explicit recovery rules.
- [PHP integration](/docs/en/php.md): Runnable chat, image and video clients with explicit recovery rules.
- [Changelog](/docs/en/changelog.md): Versioned changes to the API contract.

## zh-CN

- [快速开始](/docs/zh-CN/quickstart.md): 完成首个经认证的请求。
- [身份验证](/docs/zh-CN/auth.md): Bearer 密钥、安全保存与轮换。
- [模型与价格](/docs/zh-CN/models.md): 模型能力、执行模式与生效价格。
- [对话补全](/docs/zh-CN/chat.md): OpenAI 风格对话请求与 SSE 流式输出。
- [图片生成](/docs/zh-CN/images.md): 同步结果与异步图片任务。
- [视频生成](/docs/zh-CN/videos.md): 提交并查看视频生成任务。
- [任务与幂等](/docs/zh-CN/tasks.md): 查询已接受任务，避免重复提交。
- [余额与计费](/docs/zh-CN/billing.md): 预付美元、预占、结算和支付状态。
- [API Key 管理](/docs/zh-CN/keys.md): 消费限额、过期、限制与用量归属。
- [错误与限制](/docs/zh-CN/errors.md): 稳定错误码与可执行的恢复方式。
- [生产接入](/docs/zh-CN/production.md): 超时、对账、日志与上线条件。
- [参考 URL 与临时素材](/docs/zh-CN/uploads.md): 外部参考 URL 与 Playground 临时素材上传。
- [Python 接入](/docs/zh-CN/python.md): 可运行的对话、图片、视频客户端，包含明确的异常恢复规则。
- [TypeScript / Node.js 接入](/docs/zh-CN/typescript.md): 可运行的对话、图片、视频客户端，包含明确的异常恢复规则。
- [Go 接入](/docs/zh-CN/go.md): 可运行的对话、图片、视频客户端，包含明确的异常恢复规则。
- [PHP 接入](/docs/zh-CN/php.md): 可运行的对话、图片、视频客户端，包含明确的异常恢复规则。
- [更新记录](/docs/zh-CN/changelog.md): API 契约的版本变更。

## ja

- [クイックスタート](/docs/ja/quickstart.md): 認証付きの最初のリクエストを送信します。
- [認証](/docs/ja/auth.md): Bearer キー、安全な保管、キーのローテーション。
- [モデルと価格](/docs/ja/models.md): モデルの機能、実行モード、適用価格。
- [チャット（Chat completions）](/docs/ja/chat.md): OpenAI 形式のチャットリクエストと SSE ストリーミング。
- [画像生成](/docs/ja/images.md): 同期の生成結果と非同期の画像タスク。
- [動画生成](/docs/ja/videos.md): 動画タスクの送信と状態確認。
- [タスクと冪等性](/docs/ja/tasks.md): 重複送信を避けながら、受け付け済みのタスクを確認します。
- [残高と課金](/docs/ja/billing.md): 前払いの USD 残高、仮押さえ、利用額の確定、決済状態。
- [API キーの管理](/docs/ja/keys.md): 利用上限、有効期限、制限、利用実績の帰属。
- [エラーと制限](/docs/ja/errors.md): 安定したエラーコードと具体的な復旧手順。
- [本番環境への接続](/docs/ja/production.md): タイムアウト、照合、ログ、リリース条件。
- [参考 URL と一時入力](/docs/ja/uploads.md): 外部参考 URL と Playground の一時アップロード。
- [Python 連携ガイド](/docs/ja/python.md): チャット・画像・動画の実行可能なクライアントと、エラー時の復旧手順。
- [TypeScript / Node.js 連携ガイド](/docs/ja/typescript.md): チャット・画像・動画の実行可能なクライアントと、エラー時の復旧手順。
- [Go 連携ガイド](/docs/ja/go.md): チャット・画像・動画の実行可能なクライアントと、エラー時の復旧手順。
- [PHP 連携ガイド](/docs/ja/php.md): チャット・画像・動画の実行可能なクライアントと、エラー時の復旧手順。
- [更新履歴](/docs/ja/changelog.md): API 契約のバージョンごとの変更内容。

## ko

- [빠른 시작](/docs/ko/quickstart.md): 인증된 첫 요청을 실행하세요.
- [인증](/docs/ko/auth.md): Bearer 키, 안전한 보관 및 키 교체.
- [모델 및 가격](/docs/ko/models.md): 모델 기능, 실행 방식 및 적용 가격.
- [채팅 완성](/docs/ko/chat.md): OpenAI 스타일 채팅 요청과 SSE 스트리밍.
- [이미지 생성](/docs/ko/images.md): 동기 결과와 비동기 이미지 작업.
- [동영상 생성](/docs/ko/videos.md): 동영상 작업을 제출하고 상태를 확인하세요.
- [작업 및 멱등성](/docs/ko/tasks.md): 중복 제출 없이 수락된 작업을 폴링하세요.
- [잔액 및 과금](/docs/ko/billing.md): 선불 USD, 금액 사전 확보, 정산 및 결제 상태.
- [API key 관리](/docs/ko/keys.md): 사용 한도, 만료, 제한 및 사용량 귀속.
- [오류 및 제한](/docs/ko/errors.md): 일관된 오류 코드와 실행 가능한 복구 방법.
- [프로덕션 체크리스트](/docs/ko/production.md): 타임아웃, 대사, 로깅 및 출시 조건.
- [참조 URL 및 임시 입력](/docs/ko/uploads.md): 외부 참조 URL과 Playground 임시 업로드.
- [Python 연동 가이드](/docs/ko/python.md): 실행 가능한 채팅·이미지·동영상 클라이언트와 오류 복구 절차.
- [TypeScript / Node.js 연동 가이드](/docs/ko/typescript.md): 실행 가능한 채팅·이미지·동영상 클라이언트와 오류 복구 절차.
- [Go 연동 가이드](/docs/ko/go.md): 실행 가능한 채팅·이미지·동영상 클라이언트와 오류 복구 절차.
- [PHP 연동 가이드](/docs/ko/php.md): 실행 가능한 채팅·이미지·동영상 클라이언트와 오류 복구 절차.
- [변경 이력](/docs/ko/changelog.md): API 계약의 버전별 변경 사항.

## fr

- [Démarrage rapide](/docs/fr/quickstart.md): Envoyez votre première requête authentifiée.
- [Authentification](/docs/fr/auth.md): Clés Bearer, stockage sécurisé et renouvellement des clés.
- [Modèles et tarifs](/docs/fr/models.md): Capacités, modes d’exécution et prix applicables.
- [Complétions de chat](/docs/fr/chat.md): Requêtes de chat de type OpenAI et streaming SSE.
- [Génération d’images](/docs/fr/images.md): Résultats synchrones et tâches d’images asynchrones.
- [Génération de vidéos](/docs/fr/videos.md): Soumission et suivi des tâches vidéo.
- [Tâches et idempotence](/docs/fr/tasks.md): Consultez les traitements acceptés sans les soumettre deux fois.
- [Solde et facturation](/docs/fr/billing.md): Solde prépayé en USD, réservations, débits définitifs et état des paiements.
- [Gestion des clés API](/docs/fr/keys.md): Plafonds de dépense, expiration, restrictions et attribution de l’utilisation.
- [Erreurs et limites](/docs/fr/errors.md): Codes d’erreur stables et mesures de reprise concrètes.
- [Intégration en production](/docs/fr/production.md): Délais d’attente, rapprochement, journaux et conditions de mise en service.
- [URL de référence et entrées temporaires](/docs/fr/uploads.md): URL externes et téléversements temporaires dans Playground.
- [Python — guide d’intégration](/docs/fr/python.md): Clients exécutables de chat, d’images et de vidéos, avec des règles de reprise explicites.
- [TypeScript / Node.js — guide d’intégration](/docs/fr/typescript.md): Clients exécutables de chat, d’images et de vidéos, avec des règles de reprise explicites.
- [Go — guide d’intégration](/docs/fr/go.md): Clients exécutables de chat, d’images et de vidéos, avec des règles de reprise explicites.
- [PHP — guide d’intégration](/docs/fr/php.md): Clients exécutables de chat, d’images et de vidéos, avec des règles de reprise explicites.
- [Historique des modifications](/docs/fr/changelog.md): Évolution du contrat API, version par version.

## es

- [Inicio rápido](/docs/es/quickstart.md): Realiza tu primera solicitud autenticada.
- [Autenticación](/docs/es/auth.md): Claves Bearer, almacenamiento seguro y rotación de claves.
- [Modelos y precios](/docs/es/models.md): Capacidades, modos de ejecución y precios efectivos.
- [Completaciones de chat](/docs/es/chat.md): Solicitudes de chat de estilo OpenAI y streaming SSE.
- [Generación de imágenes](/docs/es/images.md): Resultados síncronos y tareas asíncronas de imágenes.
- [Generación de vídeos](/docs/es/videos.md): Envía y supervisa tareas de vídeo.
- [Tareas e idempotencia](/docs/es/tasks.md): Consulta el trabajo aceptado sin enviarlo dos veces.
- [Saldo y facturación](/docs/es/billing.md): Dólares prepagados, retenciones, liquidación y estado de pagos.
- [Controles de claves de API](/docs/es/keys.md): Límites de gasto, caducidad, restricciones y atribución del uso.
- [Errores y límites](/docs/es/errors.md): Códigos de error estables y medidas concretas de recuperación.
- [Lista de verificación para producción](/docs/es/production.md): Tiempos de espera, conciliación, registros y requisitos de lanzamiento.
- [URL de referencia y entradas temporales](/docs/es/uploads.md): URL externas y subidas temporales en Playground.
- [Python — guía de integración](/docs/es/python.md): Clientes ejecutables de chat, imágenes y vídeos con reglas explícitas de recuperación.
- [TypeScript / Node.js — guía de integración](/docs/es/typescript.md): Clientes ejecutables de chat, imágenes y vídeos con reglas explícitas de recuperación.
- [Go — guía de integración](/docs/es/go.md): Clientes ejecutables de chat, imágenes y vídeos con reglas explícitas de recuperación.
- [PHP — guía de integración](/docs/es/php.md): Clientes ejecutables de chat, imágenes y vídeos con reglas explícitas de recuperación.
- [Historial de cambios](/docs/es/changelog.md): Cambios del contrato de la API por versión.

## ru

- [Быстрый старт](/docs/ru/quickstart.md): Отправьте первый запрос с аутентификацией.
- [Аутентификация](/docs/ru/auth.md): Bearer-ключи, безопасное хранение и замена ключей.
- [Модели и цены](/docs/ru/models.md): Возможности моделей, режимы выполнения и применимые цены.
- [Генерация ответов в чате](/docs/ru/chat.md): Запросы чата в стиле OpenAI и потоковая передача SSE.
- [Генерация изображений](/docs/ru/images.md): Синхронные результаты и асинхронные задачи генерации изображений.
- [Генерация видео](/docs/ru/videos.md): Отправка видеозадач и проверка их состояния.
- [Задачи и идемпотентность](/docs/ru/tasks.md): Проверяйте принятые задачи, избегая повторной отправки.
- [Баланс и тарификация](/docs/ru/billing.md): Предоплаченный баланс USD, резервы, окончательные списания и состояния платежей.
- [Управление API-ключами](/docs/ru/keys.md): Лимиты расходов, сроки действия, ограничения и учёт использования.
- [Ошибки и ограничения](/docs/ru/errors.md): Стабильные коды ошибок и конкретные действия для восстановления.
- [Интеграция для промышленной эксплуатации](/docs/ru/production.md): Тайм-ауты, сверка, журналы и условия выпуска.
- [URL и временные входные файлы](/docs/ru/uploads.md): Внешние URL и временная загрузка в Playground.
- [Python — руководство по интеграции](/docs/ru/python.md): Готовые к запуску клиенты чата, изображений и видео с явными правилами восстановления после ошибок.
- [TypeScript / Node.js — руководство по интеграции](/docs/ru/typescript.md): Готовые к запуску клиенты чата, изображений и видео с явными правилами восстановления после ошибок.
- [Go — руководство по интеграции](/docs/ru/go.md): Готовые к запуску клиенты чата, изображений и видео с явными правилами восстановления после ошибок.
- [PHP — руководство по интеграции](/docs/ru/php.md): Готовые к запуску клиенты чата, изображений и видео с явными правилами восстановления после ошибок.
- [История изменений](/docs/ru/changelog.md): Изменения контракта API по версиям.