Claude Platform Docs

Бета

Models
beta_api_error: object{ message, type }
message: string
type: "api_error"
beta_authentication_error: object{ message, type }
message: string
type: "authentication_error"
beta_billing_error: object{ message, type }
message: string
type: "billing_error"
beta_currency: "USD"
"USD"
beta_error: BetaInvalidRequestError { message, type } or BetaAuthenticationError { message, type } or BetaBillingError { message, type } or 6 more
beta_error_response: object{ error, request_id, type }
beta_gateway_timeout_error: object{ message, type }
message: string
type: "timeout_error"
beta_invalid_request_error: object{ message, type }
message: string
type: "invalid_request_error"
beta_monetary_amount: 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: "USD"

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.

beta_not_found_error: object{ message, type }
message: string
type: "not_found_error"
beta_overloaded_error: object{ message, type }
message: string
type: "overloaded_error"
beta_permission_error: object{ message, type }
message: string
type: "permission_error"
beta_rate_limit_error: object{ message, type }
message: string
type: "rate_limit_error"

БетаМодели

Список моделей
$ ant beta:models list
GET/v1/models
Получить модель
$ ant beta:models retrieve
GET/v1/models/{model_id}

БетаСообщения

Создать сообщение
$ ant beta:messages create
POST/v1/messages
Подсчитать токены в сообщении
$ ant beta:messages count-tokens
POST/v1/messages/count_tokens

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

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

БетаАгенты

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

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

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

БетаСреды

Создать среду
$ ant beta:environments create
POST/v1/environments
Список сред
$ ant beta:environments list
GET/v1/environments
Получить среду
$ ant beta:environments retrieve
GET/v1/environments/{environment_id}
Обновить среду
$ ant beta:environments update
POST/v1/environments/{environment_id}
Удалить среду
$ ant beta:environments delete
DELETE/v1/environments/{environment_id}
Архивировать среду
$ ant beta:environments archive
POST/v1/environments/{environment_id}/archive

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

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

БетаСеансы

Создать сеанс
$ ant beta:sessions create
POST/v1/sessions
Список сеансов
$ ant beta:sessions list
GET/v1/sessions
Получить сеанс
$ ant beta:sessions retrieve
GET/v1/sessions/{session_id}
Обновить сеанс
$ ant beta:sessions update
POST/v1/sessions/{session_id}
Удалить сеанс
$ ant beta:sessions delete
DELETE/v1/sessions/{session_id}
Архивировать сеанс
$ ant beta:sessions archive
POST/v1/sessions/{session_id}/archive

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

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

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

Добавить ресурс сеанса
$ ant beta:sessions:resources add
POST/v1/sessions/{session_id}/resources
Список ресурсов сеанса
$ ant beta:sessions:resources list
GET/v1/sessions/{session_id}/resources
Получить ресурс сеанса
$ ant beta:sessions:resources retrieve
GET/v1/sessions/{session_id}/resources/{resource_id}
Обновить ресурс сеанса
$ ant beta:sessions:resources update
POST/v1/sessions/{session_id}/resources/{resource_id}
Удалить ресурс сеанса
$ ant beta:sessions:resources delete
DELETE/v1/sessions/{session_id}/resources/{resource_id}

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

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

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

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

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

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

БетаЗапуски развёртывания

Список запусков развёртывания
$ ant beta:deployment-runs list
GET/v1/deployment_runs
Получить запуск развёртывания
$ ant beta:deployment-runs retrieve
GET/v1/deployment_runs/{deployment_run_id}

БетаСейфы

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

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

Создать учётные данные
$ ant beta:vaults:credentials create
POST/v1/vaults/{vault_id}/credentials
Список учётных данных
$ ant beta:vaults:credentials list
GET/v1/vaults/{vault_id}/credentials
Получить учётные данные
$ ant beta:vaults:credentials retrieve
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Обновить учётные данные
$ ant beta:vaults:credentials update
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Удалить учётные данные
$ ant beta:vaults:credentials delete
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Архивировать учётные данные
$ ant beta:vaults:credentials archive
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Проверить учётные данные
$ ant beta:vaults:credentials mcp-oauth-validate
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate

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

Создать хранилище памяти
$ ant beta:memory-stores create
POST/v1/memory_stores
Список хранилищ памяти
$ ant beta:memory-stores list
GET/v1/memory_stores
Получить хранилище памяти
$ ant beta:memory-stores retrieve
GET/v1/memory_stores/{memory_store_id}
Обновить хранилище памяти
$ ant beta:memory-stores update
POST/v1/memory_stores/{memory_store_id}
Удалить хранилище памяти
$ ant beta:memory-stores delete
DELETE/v1/memory_stores/{memory_store_id}
Архивировать хранилище памяти
$ ant beta:memory-stores archive
POST/v1/memory_stores/{memory_store_id}/archive

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

Создать запись памяти
$ ant beta:memory-stores:memories create
POST/v1/memory_stores/{memory_store_id}/memories
Список записей памяти
$ ant beta:memory-stores:memories list
GET/v1/memory_stores/{memory_store_id}/memories
Получить запись памяти
$ ant beta:memory-stores:memories retrieve
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Обновить запись памяти
$ ant beta:memory-stores:memories update
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Удалить запись памяти
$ ant beta:memory-stores:memories delete
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}

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

Список версий записи памяти
$ ant beta:memory-stores:memory-versions list
GET/v1/memory_stores/{memory_store_id}/memory_versions
Получить версию записи памяти
$ ant beta:memory-stores:memory-versions retrieve
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
Скрыть содержимое версии записи памяти
$ ant beta:memory-stores:memory-versions redact
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

БетаФайлы

Загрузить файл
$ ant beta:files upload
POST/v1/files
Список файлов
$ ant beta:files list
GET/v1/files
Скачать файл
$ ant beta:files download
GET/v1/files/{file_id}/content
Получить метаданные файла
$ ant beta:files retrieve-metadata
GET/v1/files/{file_id}
Удалить файл
$ ant beta:files delete
DELETE/v1/files/{file_id}

БетаНавыки

Создать навык
$ ant beta:skills create
POST/v1/skills
Список навыков
$ ant beta:skills list
GET/v1/skills
Получить навык
$ ant beta:skills retrieve
GET/v1/skills/{skill_id}
Удалить навык
$ ant beta:skills delete
DELETE/v1/skills/{skill_id}

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

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

БетаПрофили пользователей

Создать профиль пользователя
$ ant beta:user-profiles create
POST/v1/user_profiles
Список профилей пользователей
$ ant beta:user-profiles list
GET/v1/user_profiles
Получить профиль пользователя
$ ant beta:user-profiles retrieve
GET/v1/user_profiles/{user_profile_id}
Обновить профиль пользователя
$ ant beta:user-profiles update
POST/v1/user_profiles/{user_profile_id}
Создать URL регистрации
$ ant beta:user-profiles create-enrollment-url
POST/v1/user_profiles/{user_profile_id}/enrollment_url

БетаСны

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

БетаТуннели

Создать туннель
$ ant beta:tunnels create
POST/v1/tunnels
Получить туннель
$ ant beta:tunnels retrieve
GET/v1/tunnels/{tunnel_id}
Список туннелей
$ ant beta:tunnels list
GET/v1/tunnels
Архивировать туннель
$ ant beta:tunnels archive
POST/v1/tunnels/{tunnel_id}/archive
Показать токен туннеля
$ ant beta:tunnels reveal-token
POST/v1/tunnels/{tunnel_id}/reveal_token
Ротация токена туннеля
$ ant beta:tunnels rotate-token
POST/v1/tunnels/{tunnel_id}/rotate_token

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

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

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

Получить текущую организацию
$ ant beta:organization retrieve
GET/v1/organizations/me

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

Список ключей API
$ ant beta:organization:api-keys list
GET/v1/organizations/api_keys
Получить ключ API
$ ant beta:organization:api-keys retrieve
GET/v1/organizations/api_keys/{api_key_id}
Обновить ключ API
$ ant beta:organization:api-keys update
POST/v1/organizations/api_keys/{api_key_id}

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

Создать внешний ключ
$ ant beta:organization:external-keys create
POST/v1/organizations/external_keys
Список внешних ключей
$ ant beta:organization:external-keys list
GET/v1/organizations/external_keys
Получить внешний ключ
$ ant beta:organization:external-keys retrieve
GET/v1/organizations/external_keys/{external_key_id}
Обновить внешний ключ
$ ant beta:organization:external-keys update
POST/v1/organizations/external_keys/{external_key_id}
Удалить внешний ключ
$ ant beta:organization:external-keys delete
DELETE/v1/organizations/external_keys/{external_key_id}
Проверить внешний ключ
$ ant beta:organization:external-keys validate
POST/v1/organizations/external_keys/{external_key_id}/validate

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

Создать издателя федерации
$ ant beta:organization:federation:issuers create
POST/v1/organizations/federation_issuers
Список издателей федерации
$ ant beta:organization:federation:issuers list
GET/v1/organizations/federation_issuers
Получить издателя федерации
$ ant beta:organization:federation:issuers retrieve
GET/v1/organizations/federation_issuers/{federation_issuer_id}
Обновить издателя федерации
$ ant beta:organization:federation:issuers update
POST/v1/organizations/federation_issuers/{federation_issuer_id}
Архивировать издателя федерации
$ ant beta:organization:federation:issuers archive
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

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

Создать правило федерации
$ ant beta:organization:federation:rules create
POST/v1/organizations/federation_rules
Список правил федерации
$ ant beta:organization:federation:rules list
GET/v1/organizations/federation_rules
Получить правило федерации
$ ant beta:organization:federation:rules retrieve
GET/v1/organizations/federation_rules/{federation_rule_id}
Обновить правило федерации
$ ant beta:organization:federation:rules update
POST/v1/organizations/federation_rules/{federation_rule_id}
Архивировать правило федерации
$ ant beta:organization:federation:rules archive
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

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

Добавить рабочее пространство правила федерации
$ ant beta:organization:federation:rules:workspaces add
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Список рабочих пространств правила федерации
$ ant beta:organization:federation:rules:workspaces list
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Удалить рабочее пространство правила федерации
$ ant beta:organization:federation:rules:workspaces remove
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

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

Создать приглашение
$ ant beta:organization:invites create
POST/v1/organizations/invites
Список приглашений
$ ant beta:organization:invites list
GET/v1/organizations/invites
Получить приглашение
$ ant beta:organization:invites retrieve
GET/v1/organizations/invites/{invite_id}
Удалить приглашение
$ ant beta:organization:invites delete
DELETE/v1/organizations/invites/{invite_id}

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

Создать сервисный аккаунт
$ ant beta:organization:service-accounts create
POST/v1/organizations/service_accounts
Список сервисных аккаунтов
$ ant beta:organization:service-accounts list
GET/v1/organizations/service_accounts
Получить сервисный аккаунт
$ ant beta:organization:service-accounts retrieve
GET/v1/organizations/service_accounts/{service_account_id}
Обновить сервисный аккаунт
$ ant beta:organization:service-accounts update
POST/v1/organizations/service_accounts/{service_account_id}
Архивировать сервисный аккаунт
$ ant beta:organization:service-accounts archive
POST/v1/organizations/service_accounts/{service_account_id}/archive

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

Добавить рабочее пространство к сервисному аккаунту
$ ant beta:organization:service-accounts:workspaces add
POST/v1/organizations/service_accounts/{service_account_id}/workspaces
Список рабочих пространств сервисного аккаунта
$ ant beta:organization:service-accounts:workspaces list
GET/v1/organizations/service_accounts/{service_account_id}/workspaces
Удалить рабочее пространство из сервисного аккаунта
$ ant beta:organization:service-accounts:workspaces remove
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

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

Список пользователей
$ ant beta:organization:users list
GET/v1/organizations/users
Получить пользователя
$ ant beta:organization:users retrieve
GET/v1/organizations/users/{user_id}
Обновить пользователя
$ ant beta:organization:users update
POST/v1/organizations/users/{user_id}
Удалить пользователя
$ ant beta:organization:users remove
DELETE/v1/organizations/users/{user_id}

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

Список рабочих пространств
$ ant beta:organization:workspaces list
GET/v1/organizations/workspaces
Создать рабочее пространство
$ ant beta:organization:workspaces create
POST/v1/organizations/workspaces
Получить рабочее пространство
$ ant beta:organization:workspaces retrieve
GET/v1/organizations/workspaces/{workspace_id}
Обновить рабочее пространство
$ ant beta:organization:workspaces update
POST/v1/organizations/workspaces/{workspace_id}
Архивировать рабочее пространство
$ ant beta:organization:workspaces archive
POST/v1/organizations/workspaces/{workspace_id}/archive

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

Список ограничений скорости рабочего пространства
$ ant beta:organization:workspaces:rate-limits list
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

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

Список участников рабочего пространства
$ ant beta:organization:workspaces:members list
GET/v1/organizations/workspaces/{workspace_id}/members
Создать участника рабочего пространства
$ ant beta:organization:workspaces:members add
POST/v1/organizations/workspaces/{workspace_id}/members
Получить участника рабочего пространства
$ ant beta:organization:workspaces:members retrieve
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Обновить участника рабочего пространства
$ ant beta:organization:workspaces:members update
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Удалить участника рабочего пространства
$ ant beta:organization:workspaces:members remove
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

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

Список участников рабочего пространства — сервисных аккаунтов
$ ant beta:organization:workspaces:service-accounts list
GET/v1/organizations/workspaces/{workspace_id}/service_accounts
Создать участника рабочего пространства — сервисный аккаунт
$ ant beta:organization:workspaces:service-accounts add
POST/v1/organizations/workspaces/{workspace_id}/service_accounts
Получить участника рабочего пространства — сервисный аккаунт
$ ant beta:organization:workspaces:service-accounts retrieve
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Обновить участника рабочего пространства — сервисный аккаунт
$ ant beta:organization:workspaces:service-accounts update
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Удалить участника рабочего пространства — сервисный аккаунт
$ ant beta:organization:workspaces:service-accounts remove
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

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

Список ограничений скорости организации
$ ant beta:organization:rate-limits list
GET/v1/organizations/rate_limits

БетаОрганизацияНастройки соответствия требованиям

Получение настроек соответствия требованиям
$ ant beta:organization:compliance-settings retrieve
GET/v1/organizations/compliance_settings
Обновление настроек соответствия требованиям
$ ant beta:organization:compliance-settings update
POST/v1/organizations/compliance_settings