Структура документации и маршруты

Что это за страница

Эта страница помогает быстро понять структуру публичной документации и где искать нужные разделы.

Разделы публичной документации

• overview — обзор платформы и ключевые сценарии.
• getting-started — аккаунт, API-ключи, первый запрос.
• auth — схема авторизации и безопасная работа с ключами.
• integrations — настройка IDE и клиентов (включая Claude Code).
• technical — интерфейс и архитектура на высоком уровне.
• multimodal — text, images, audio, video, files/PDF.
• testing — чек-листы проверки интеграции.
• guides — практические гайды (streaming, troubleshooting, billing).
• dashboard — обзор разделов кабинета.

Публичные API-маршруты

RouterAPI поддерживает два совместимых внешних входа:

• OpenAI-compatible: https://routerapi.ru/api/v1/*
  • пример: POST /api/v1/chat/completions
• Anthropic-compatible: https://routerapi.ru/v1/*
  • пример: POST /v1/messages

Оба входа используют один и тот же API-ключ пользователя.

Навигация по docs

• /docs — обзор.
• /docs/getting-started/* — быстрый старт.
• /docs/auth/* — авторизация.
• /docs/integrations/* — IDE и клиенты.
• /docs/technical/* — интерфейс и архитектура.
• /docs/multimodal/* — мультимодальность.
• /docs/testing/* — тестирование интеграций.
• /docs/guides/* — эксплуатационные гайды.

Принципы публикации

• В docs/* публикуется только customer-facing информация.
• Примеры используют только плейсхолдеры (YOUR_API_KEY, api.example.com).
• В публичных страницах не публикуются внутренние runbook, инфраструктурные детали и секреты.