POST/v1/messages

Требуемое право: text. Неизвестные поля и неподдерживаемые формы отклоняются до резервирования. Совместимость ограничена этой схемой.

Авторизация

Authorizationstringобязательный

Ключ API в заголовке Authorization: Bearer <ключ>. Ключ создаётся в кабинете, подробнее — в разделе Аутентификация.

x-api-keystring

Альтернатива для клиентов формата Messages: ключ в заголовке x-api-key.

Заголовки

Idempotency-Keystringобязательныйдлина 1–200

Один стабильный ключ на логический запрос. Повторяйте с тем же телом и тем же credential/endpoint. Новый ключ создаёт новый запрос.

anthropic-version"2023-06-01"

Тело запроса

application/json · обязательное

modelstringобязательныйдлина 1–200
messagesobject[]обязательныйэлементов 1–1000
Вложенные поля
rolestringобязательный
Значения: "user" "assistant"
contentstring | object[]обязательный
Вложенные поля
Один из вариантов
Вариант 1
type"text"обязательный
textstringобязательный
max_tokensintegerобязательный1 … 32768
systemstring
temperaturenumber0 … 1
streamfalseпо умолчанию false

Ответы

200Успешный ответ

application/json

idstringобязательный
type"message"обязательный
role"assistant"обязательный
contentobject[]обязательный
Вложенные поля
type"text"обязательный
textstringобязательный
usageobjectобязательный
modelstring
stop_reasonstring
Значения: "end_turn" "max_tokens"
billingobject
Вложенные поля
statusstring
estimated_cost_microrubinteger0 … 9007199254740991
cost_microrubinteger | null
202Исход уточняется; резерв сохраняется

application/json

Обработка или сверка ещё не завершена. Сохраняйте исходный Idempotency-Key и тело. Резерв удерживается. Не создавайте новый запрос взамен этого.

Тип: object

ОшибкаОшибка проверки, прав, лимита или доступности. Код error.code; результат запроса при неизвестном исходе не следует считать отменённым.

application/json

errorobjectобязательный
Вложенные поля
codestringобязательный
messagestringобязательный
request_idstring
typestring