Skip to Content
API ReferenceОбзор

Обзор

Базовый URL

https://api.neuroartist.ru

Аутентификация

Authorization: Bearer na_live_xxxxxxxxxxxxxxxx

Подробнее — Аутентификация.

Формат

  • Запросы: Content-Type: application/json (либо multipart/form-data для /me/uploads).
  • Ответы: application/json (кроме /metrics).
  • Кодировка: UTF-8.
  • Баланс и суммы — целые числа в рублях.
  • Даты — ISO 8601 UTC (2026-04-25T10:00:00Z).

Envelope ошибок

{ "error": "insufficient_balance", "message": "Not enough credits", "required": 12, "available": 5 }

Ветвите по error — стабильный machine-readable. Полный список — коды ошибок.

Стандартные headers

X-Request-ID: 01HXYZ… ← в каждом ответе X-RateLimit-Limit: 100 X-RateLimit-Remaining: 99 X-RateLimit-Reset: 1714050300 Retry-After: 47 ← при 429/503

CORS

Access-Control-Allow-Origin: <FRONTEND_ORIGINS allowlist> Access-Control-Allow-Credentials: true Access-Control-Expose-Headers: X-Request-ID, X-RateLimit-*, Retry-After

Cross-origin браузер → credentials: 'include' для session cookie.

OpenAPI

URLЧто
/openapi.jsonOpenAPI 3.1 (EN) — для генерации SDK
/openapi.ru.jsonRU overlay
/docsScalar UI
/llms.txtToken-optimized markdown для LLM
/llms-full.txtПолная markdown-документация

В production /admin/* и /webhooks/yookassa/* отфильтрованы из спеки.

Группы ручек

ПрефиксГруппаНазначение
/models/*ModelsКаталог
/run/{modelId}RunSync-генерация
/queue/{modelId}/*QueueAsync-генерация + polling
/v1/*OpenAI compatibilityOpenAI-shaped images API
/me/*MeПрофиль, ключи, активность, баланс
/billing/*БиллингПополнение через YooKassa
/webhooks/yookassa/*YooKassa callbacksServer-to-server, не для клиентского кода
/health, /metricsHealthLiveness, Prometheus

Версионирование

API не версионируется в URL. Изменения — обратно совместимо. Список — GET /changelog.json.

Дальше

  • Шпаргалка по API — все публичные эндпоинты одним списком.
  • /run — синхронная генерация.
  • /queue — async, polling и cancel.