Claude Platform Docs

Бета

Models
AnthropicBeta = string or "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more
One of the following:
BetaAPIError object{ message, type }
message: string
defaultInternal server error
type: "api_error"
defaultapi_error
BetaAuthenticationError object{ message, type }
message: string
defaultAuthentication error
type: "authentication_error"
defaultauthentication_error
BetaBillingError object{ message, type }
message: string
defaultBilling error
type: "billing_error"
defaultbilling_error
BetaCurrency = "USD"
BetaError = BetaInvalidRequestError { message, type } or BetaAuthenticationError { message, type } or BetaBillingError { message, type } or 6 more
One of the following:
BetaErrorResponse object{ error, request_id, type }
error: BetaError
One of the following:
request_id: string or null
type: "error"
defaulterror
BetaGatewayTimeoutError object{ message, type }
message: string
defaultRequest timeout
type: "timeout_error"
defaulttimeout_error
BetaInvalidRequestError object{ message, type }
message: string
defaultInvalid request
type: "invalid_request_error"
defaultinvalid_request_error
BetaMonetaryAmount object{ amount, currency }

A monetary amount in a specific currency.

amount: string

Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

currency: BetaCurrency

Uppercase ISO-4217 currency code. USD is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.

BetaNotFoundError object{ message, type }
message: string
defaultNot found
type: "not_found_error"
defaultnot_found_error
BetaOverloadedError object{ message, type }
message: string
defaultOverloaded
type: "overloaded_error"
defaultoverloaded_error
BetaPermissionError object{ message, type }
message: string
defaultPermission denied
type: "permission_error"
defaultpermission_error
BetaRateLimitError object{ message, type }
message: string
defaultRate limited
type: "rate_limit_error"
defaultrate_limit_error

БетаМодели

Список моделей
GET/v1/models
Получить модель
GET/v1/models/{model_id}

БетаСообщенияПакеты

Создать пакет сообщений
POST/v1/messages/batches
Получить пакет сообщений
GET/v1/messages/batches/{message_batch_id}
Список пакетов сообщений
GET/v1/messages/batches
Отменить пакет сообщений
POST/v1/messages/batches/{message_batch_id}/cancel
Удалить пакет сообщений
DELETE/v1/messages/batches/{message_batch_id}
Получить результаты пакета сообщений
GET/v1/messages/batches/{message_batch_id}/results

БетаАгенты

Создать агента
POST/v1/agents
Список агентов
GET/v1/agents
Получить агента
GET/v1/agents/{agent_id}
Обновить агента
POST/v1/agents/{agent_id}
Архивировать агента
POST/v1/agents/{agent_id}/archive

БетаАгентыВерсии

Список версий агента
GET/v1/agents/{agent_id}/versions

БетаСреды

Создать среду
POST/v1/environments
Список сред
GET/v1/environments
Получить среду
GET/v1/environments/{environment_id}
Обновить среду
POST/v1/environments/{environment_id}
Удалить среду
DELETE/v1/environments/{environment_id}
Архивировать среду
POST/v1/environments/{environment_id}/archive

БетаСредыРабота

Получить рабочий элемент
GET/v1/environments/{environment_id}/work/{work_id}
Опросить наличие работы
GET/v1/environments/{environment_id}/work/poll
Подтвердить получение работы
POST/v1/environments/{environment_id}/work/{work_id}/ack
Записать сигнал активности
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat
Остановить работу
POST/v1/environments/{environment_id}/work/{work_id}/stop
Список рабочих элементов
GET/v1/environments/{environment_id}/work
Обновить рабочий элемент
POST/v1/environments/{environment_id}/work/{work_id}
Получить статистику очереди
GET/v1/environments/{environment_id}/work/stats

БетаСеансы

Создать сеанс
POST/v1/sessions
Список сеансов
GET/v1/sessions
Получить сеанс
GET/v1/sessions/{session_id}
Обновить сеанс
POST/v1/sessions/{session_id}
Удалить сеанс
DELETE/v1/sessions/{session_id}
Архивировать сеанс
POST/v1/sessions/{session_id}/archive

БетаСеансыСобытия

Список событий
GET/v1/sessions/{session_id}/events
Отправить события
POST/v1/sessions/{session_id}/events
Потоковая передача событий
GET/v1/sessions/{session_id}/events/stream

БетаСеансыРесурсы

Добавить ресурс сеанса
POST/v1/sessions/{session_id}/resources
Список ресурсов сеанса
GET/v1/sessions/{session_id}/resources
Получить ресурс сеанса
GET/v1/sessions/{session_id}/resources/{resource_id}
Обновить ресурс сеанса
POST/v1/sessions/{session_id}/resources/{resource_id}
Удалить ресурс сеанса
DELETE/v1/sessions/{session_id}/resources/{resource_id}

БетаСеансыПотоки

Список потоков сеанса
GET/v1/sessions/{session_id}/threads
Получить поток сеанса
GET/v1/sessions/{session_id}/threads/{thread_id}
Архивировать поток сеанса
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

БетаСеансыПотокиСобытия

Список событий потока сеанса
GET/v1/sessions/{session_id}/threads/{thread_id}/events
Потоковая передача событий потока сеанса
GET/v1/sessions/{session_id}/threads/{thread_id}/stream

БетаРазвёртывания

Создать развёртывание
POST/v1/deployments
Список развёртываний
GET/v1/deployments
Получить развёртывание
GET/v1/deployments/{deployment_id}
Обновить развёртывание
POST/v1/deployments/{deployment_id}
Архивировать развёртывание
POST/v1/deployments/{deployment_id}/archive
Запустить развёртывание сейчас
POST/v1/deployments/{deployment_id}/run
Приостановить развёртывание
POST/v1/deployments/{deployment_id}/pause
Возобновить развёртывание
POST/v1/deployments/{deployment_id}/unpause

БетаСейфы

Создать сейф
POST/v1/vaults
Список сейфов
GET/v1/vaults
Получить сейф
GET/v1/vaults/{vault_id}
Обновить сейф
POST/v1/vaults/{vault_id}
Удалить сейф
DELETE/v1/vaults/{vault_id}
Архивировать сейф
POST/v1/vaults/{vault_id}/archive

БетаСейфыУчётные данные

Создать учётные данные
POST/v1/vaults/{vault_id}/credentials
Список учётных данных
GET/v1/vaults/{vault_id}/credentials
Получить учётные данные
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Обновить учётные данные
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Удалить учётные данные
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Архивировать учётные данные
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Проверить учётные данные
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate

БетаХранилища памяти

Создать хранилище памяти
POST/v1/memory_stores
Список хранилищ памяти
GET/v1/memory_stores
Получить хранилище памяти
GET/v1/memory_stores/{memory_store_id}
Обновить хранилище памяти
POST/v1/memory_stores/{memory_store_id}
Удалить хранилище памяти
DELETE/v1/memory_stores/{memory_store_id}
Архивировать хранилище памяти
POST/v1/memory_stores/{memory_store_id}/archive

БетаХранилища памятиЗаписи памяти

Создать запись памяти
POST/v1/memory_stores/{memory_store_id}/memories
Список записей памяти
GET/v1/memory_stores/{memory_store_id}/memories
Получить запись памяти
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Обновить запись памяти
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Удалить запись памяти
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}

БетаХранилища памятиВерсии записей памяти

Список версий записи памяти
GET/v1/memory_stores/{memory_store_id}/memory_versions
Получить версию записи памяти
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
Скрыть содержимое версии записи памяти
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

БетаФайлы

Загрузить файл
POST/v1/files
Список файлов
GET/v1/files
Скачать файл
GET/v1/files/{file_id}/content
Получить метаданные файла
GET/v1/files/{file_id}
Удалить файл
DELETE/v1/files/{file_id}

БетаНавыки

Создать навык
POST/v1/skills
Список навыков
GET/v1/skills
Получить навык
GET/v1/skills/{skill_id}
Удалить навык
DELETE/v1/skills/{skill_id}

БетаНавыкиВерсии

Создать версию навыка
POST/v1/skills/{skill_id}/versions
Список версий навыка
GET/v1/skills/{skill_id}/versions
Скачать содержимое версии навыка
GET/v1/skills/{skill_id}/versions/{version}/content
Получить версию навыка
GET/v1/skills/{skill_id}/versions/{version}
Удалить версию навыка
DELETE/v1/skills/{skill_id}/versions/{version}

БетаВебхуки

Unwrap
Function
Parse Unverified
Function

БетаСны

Создать сон
POST/v1/dreams
Список снов
GET/v1/dreams
Получить сон
GET/v1/dreams/{dream_id}
Отменить сон
POST/v1/dreams/{dream_id}/cancel
Архивировать сон
POST/v1/dreams/{dream_id}/archive

БетаТуннели

Создать туннель
POST/v1/tunnels
Получить туннель
GET/v1/tunnels/{tunnel_id}
Список туннелей
GET/v1/tunnels
Архивировать туннель
POST/v1/tunnels/{tunnel_id}/archive
Показать токен туннеля
POST/v1/tunnels/{tunnel_id}/reveal_token
Ротация токена туннеля
POST/v1/tunnels/{tunnel_id}/rotate_token

БетаТуннелиСертификаты

Создать сертификат туннеля
POST/v1/tunnels/{tunnel_id}/certificates
Получить сертификат туннеля
GET/v1/tunnels/{tunnel_id}/certificates/{certificate_id}
Список сертификатов туннеля
GET/v1/tunnels/{tunnel_id}/certificates
Архивировать сертификат туннеля
POST/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

БетаОрганизацияКлючи API

Список ключей API
GET/v1/organizations/api_keys
Получить ключ API
GET/v1/organizations/api_keys/{api_key_id}
Обновить ключ API
POST/v1/organizations/api_keys/{api_key_id}

БетаОрганизацияВнешние ключи

Создать внешний ключ
POST/v1/organizations/external_keys
Список внешних ключей
GET/v1/organizations/external_keys
Получить внешний ключ
GET/v1/organizations/external_keys/{external_key_id}
Обновить внешний ключ
POST/v1/organizations/external_keys/{external_key_id}
Удалить внешний ключ
DELETE/v1/organizations/external_keys/{external_key_id}
Проверить внешний ключ
POST/v1/organizations/external_keys/{external_key_id}/validate

БетаОрганизацияФедерацияИздатели

Создать издателя федерации
POST/v1/organizations/federation_issuers
Список издателей федерации
GET/v1/organizations/federation_issuers
Получить издателя федерации
GET/v1/organizations/federation_issuers/{federation_issuer_id}
Обновить издателя федерации
POST/v1/organizations/federation_issuers/{federation_issuer_id}
Архивировать издателя федерации
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

БетаОрганизацияФедерацияПравила

Создать правило федерации
POST/v1/organizations/federation_rules
Список правил федерации
GET/v1/organizations/federation_rules
Получить правило федерации
GET/v1/organizations/federation_rules/{federation_rule_id}
Обновить правило федерации
POST/v1/organizations/federation_rules/{federation_rule_id}
Архивировать правило федерации
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

БетаОрганизацияФедерацияПравилаРабочие пространства

Добавить рабочее пространство правила федерации
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Список рабочих пространств правила федерации
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Удалить рабочее пространство правила федерации
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

БетаОрганизацияПриглашения

Создать приглашение
POST/v1/organizations/invites
Список приглашений
GET/v1/organizations/invites
Получить приглашение
GET/v1/organizations/invites/{invite_id}
Удалить приглашение
DELETE/v1/organizations/invites/{invite_id}

БетаОрганизацияСервисные аккаунты

Создать сервисный аккаунт
POST/v1/organizations/service_accounts
Список сервисных аккаунтов
GET/v1/organizations/service_accounts
Получить сервисный аккаунт
GET/v1/organizations/service_accounts/{service_account_id}
Обновить сервисный аккаунт
POST/v1/organizations/service_accounts/{service_account_id}
Архивировать сервисный аккаунт
POST/v1/organizations/service_accounts/{service_account_id}/archive

БетаОрганизацияСервисные аккаунтыРабочие пространства

Добавить рабочее пространство к сервисному аккаунту
POST/v1/organizations/service_accounts/{service_account_id}/workspaces
Список рабочих пространств сервисного аккаунта
GET/v1/organizations/service_accounts/{service_account_id}/workspaces
Удалить рабочее пространство из сервисного аккаунта
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

БетаОрганизацияПользователи

Список пользователей
GET/v1/organizations/users
Получить пользователя
GET/v1/organizations/users/{user_id}
Обновить пользователя
POST/v1/organizations/users/{user_id}
Удалить пользователя
DELETE/v1/organizations/users/{user_id}

БетаОрганизацияРабочие пространства

Список рабочих пространств
GET/v1/organizations/workspaces
Создать рабочее пространство
POST/v1/organizations/workspaces
Получить рабочее пространство
GET/v1/organizations/workspaces/{workspace_id}
Обновить рабочее пространство
POST/v1/organizations/workspaces/{workspace_id}
Архивировать рабочее пространство
POST/v1/organizations/workspaces/{workspace_id}/archive

БетаОрганизацияРабочие пространстваОграничения скорости

Список ограничений скорости рабочего пространства
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

БетаОрганизацияРабочие пространстваУчастники

Список участников рабочего пространства
GET/v1/organizations/workspaces/{workspace_id}/members
Создать участника рабочего пространства
POST/v1/organizations/workspaces/{workspace_id}/members
Получить участника рабочего пространства
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Обновить участника рабочего пространства
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Удалить участника рабочего пространства
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

БетаОрганизацияРабочие пространстваСервисные аккаунты

Список участников рабочего пространства — сервисных аккаунтов
GET/v1/organizations/workspaces/{workspace_id}/service_accounts
Создать участника рабочего пространства — сервисный аккаунт
POST/v1/organizations/workspaces/{workspace_id}/service_accounts
Получить участника рабочего пространства — сервисный аккаунт
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Обновить участника рабочего пространства — сервисный аккаунт
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Удалить участника рабочего пространства — сервисный аккаунт
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}