Aller au contenu
TukaiDevelopers

Rechercher dans la documentation

Console
Sommaire de la documentation

Référence de l’API

Générée depuis le contrat OpenAPI du dépôt (version 1.0.0). Fichier complet : openapi.json. Le comportement réel, ce qui est pris en charge et ce qui ne l’est pas, est décrit dans Compatibilité.

post/v1/chat/completions

OpenAI's chat completions, served by Tukai.

Authentification : Authorization: Bearer tuk_sk_…

ChampTypeRequisDescription
max_tokensintegernon
messagesarrayoui
modelstringoui
streambooleannon
temperaturenumbernon
toolsarraynon

Réponses

  • 200 — `stream:false` — one `chat.completion` object.
  • 400 — OpenAI-shaped `invalid_request_error`.
  • 401 — OpenAI-shaped.
  • 402 — OpenAI-shaped `insufficient_quota`.
  • 403 — OpenAI-shaped `permission_error`.
  • 404 — OpenAI-shaped `not_found_error`.
  • 422 — OpenAI-shaped `invalid_request_error`.
  • 429 — OpenAI-shaped `rate_limit_error`.
  • 502 — OpenAI-shaped `server_error`.
  • 503 — OpenAI-shaped `server_error`.

post/v1/messages

Anthropic's messages, served by Tukai — on ANY provider in the registry.

Authentification : Authorization: Bearer tuk_sk_…

ChampTypeRequisDescription
max_tokensintegeroui
messagesarrayoui
modelstringoui
streambooleannon
systemvariablenon
temperaturenumbernon
toolsarraynon

Réponses

  • 200 — `stream:false` — one `message` object.
  • 401 — Anthropic-shaped.
  • 402 — Anthropic-shaped `billing_error`.
  • 403 — Anthropic-shaped `permission_error`.
  • 404 — Anthropic-shaped `not_found_error`.
  • 413 — Anthropic-shaped `request_too_large`.
  • 422 — Anthropic-shaped `invalid_request_error`.
  • 429 — Anthropic-shaped `rate_limit_error`.
  • 503 — Anthropic-shaped `api_error`.
  • 529 — Anthropic-shaped `overloaded_error`.

post/v1/messages/count_tokens

How many input tokens is this? — locally, cheaply, before anything is spent.

Authentification : Authorization: Bearer tuk_sk_…

ChampTypeRequisDescription
messagesarrayoui
modelstringoui
systemvariablenon
toolsarraynon

Réponses

  • 200 —
  • 401 — Anthropic-shaped `authentication_error`.
  • 403 — Anthropic-shaped `permission_error`.
  • 404 — Anthropic-shaped `not_found_error`.
  • 422 — Anthropic-shaped `invalid_request_error`.
  • 429 — Anthropic-shaped `rate_limit_error`.

get/v1/models

The model catalogue.

Authentification : aucune (public)

Réponses

  • 200 —
  • 304 — The catalogue has not changed for this caller (ETag match).
  • 429 — Throttled per IP (RATE_LIMIT_IP, details.retry_after_ms)
  • 503 — The catalogue could not be read (SYS_SERVICE_UNAVAILABLE).