Огляд

Ендпоінти

Кожен ендпоінт розташований під одним базовим URL і обслуговується через HTTPS.

https://api.shannon-ai.com

Три ендпоінти, що створюють текст, доходять до тих самих моделей. Обирайте той, формат якого вже використовує ваш код.

Основи запитів

• Тіло кожного POST — один JSON-об'єкт, до 32 MiB.
• Поле, якого API не знає, не викликає помилки й не має наслідків. Запит, написаний для іншого провайдера, не завершується помилкою через зайве поле.
• Відоме поле з неправильним типом JSON або відсутнє обов'язкове поле отримує відповідь 422. Тіло, що не є коректним JSON, отримує 400.
• model — один з id на сторінці Models & pricing. Регістр не має значення.

Відповідь — це JSON або стрім server-sent events, якщо запит задає stream у true. Кожен ендпоінт відповідає у власному форматі. Кожна відповідь має заголовок x-request-id.

Що проходить запит

Запит перевіряється у фіксованому порядку, перш ніж запуститься модель. Відповідає перша перевірка, що не пройшла, тож 401 ще нічого не говорить про тіло.

Форма помилки

Помилка — це JSON-об'єкт з error, що містить type і message. /v1/messages загортає її так, як очікують SDK Anthropic; усі інші шляхи використовують форму OpenAI.

{
  "error": {
    "type": "invalid_request_error",
    "message": "unknown model: gpt-4o"
  }
}

{
  "type": "error",
  "error": {
    "type": "invalid_request_error",
    "message": "unknown model: gpt-4o"
  }
}

• Читайте type і message. code і param є лише в деяких помилках: вважайте їх необов'язковими. param завжди null.
• Після початку стріму статус уже 200. Збій тоді надходить як кадр помилки всередині стріму.
• Кожна відповідь з помилкою містить заголовок x-request-id.

Обробка помилок

Білінг та баланс

• На обліковий запис припадає один баланс, і чат та API ділять його: спочатку сьогоднішній ліміт плану, потім придбані кредити. Власної квоти API не має.
• Запит резервує свій бюджет виводу (max_tokens, за замовчуванням 4,096), а потім тарифікується за токени, які справді використав, за ціною моделі.
• Кожна відповідь повідомляє кількість токенів у usage. Сторінка Keys & usage показує баланс і вартість кожного запиту.
• Кожен запит обслуговується однаково. Єдине обмеження частоти запитів — захист від флуду: 120 запитів на хвилину на обліковий запис. Запити, надіслані паралельно, чекають у черзі.

Ліміти та баланс Моделі та ціни Ключі та використання

Поля, що залежать від моделі

Кожна модель приймає однаковий запит. Кілька полів діють лише на деяких моделях; таблиця вказує, на яких. Сторінки ендпоінтів перелічують кожне поле.

Chat Completions

Якщо ви переходите з SDK OpenAI

• Вкажіть базовий URL https://api.shannon-ai.com/v1, а ключ — ваш ключ Shannon. Виклики Chat Completions і Responses тоді працюють із SDK як є.
• model має бути id Shannon. Назва моделі іншого провайдера, як-от gpt-4o, отримує відповідь 400 і unknown model.
• Міркування надходить в окремому полі: reasoning_content поруч із content, у повідомленні та в дельтах стріму.
• Стрім завжди містить usage в останньому чанку разом із finish_reason.
• Виклик інструмента в стрімі надходить одним чанком із повним рядком arguments.
• Відповідь має один варіант (choice).
• Шляхи API OpenAI, яких немає в таблиці вище, як-от /v1/embeddings, отримують відповідь 404.

Якщо ви переходите з SDK Anthropic

• Вкажіть базовий URL https://api.shannon-ai.com без /v1, а ключ — ваш ключ Shannon. SDK надсилає його як x-api-key.
• model має бути id Shannon.
• max_tokens у цьому API необов'язковий. Значення за замовчуванням — 4,096.
• Відповідь містить блоки контенту типів thinking, text і tool_use. Перший блок не завжди є текстом: вибирайте блоки за type.
• stop_reason — end_turn або tool_use. Стрім моделі Shannon може також завершитися з max_tokens.
• anthropic-version і anthropic-beta приймаються, тож SDK працює без змін. Запиту вони не потрібні.
• Помилки на /v1/messages мають форму Anthropic: {"type": "error", "error": {…}}.

Інструменти для кодування, що розмовляють цими форматами, налаштовуються так само: базовий URL, ключ і id Shannon як модель. CLI-інструменти для кодування