Claude Platform Docs

Бета

Models
type AnthropicBeta = (string & {}) | "message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 47 more
One of the following:
interface BetaAPIError { type: "api_error"; message }
type: "api_error"
defaultapi_error
message: string
defaultInternal server error
interface BetaAuthenticationError { type: "authentication_error"; message }
type: "authentication_error"
defaultauthentication_error
message: string
defaultAuthentication error
interface BetaBillingError { type: "billing_error"; message }
type: "billing_error"
defaultbilling_error
message: string
defaultBilling error
type BetaCurrency = "USD"
One of the following:
interface BetaErrorResponse { type: "error"; error; request_id }
type: "error"
defaulterror
error: BetaError
One of the following:
request_id: string | null
interface BetaGatewayTimeoutError { type: "timeout_error"; message }
type: "timeout_error"
defaulttimeout_error
message: string
defaultRequest timeout
interface BetaInvalidRequestError { type: "invalid_request_error"; message }
type: "invalid_request_error"
defaultinvalid_request_error
message: string
defaultInvalid request
interface BetaMonetaryAmount { 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.

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

БетаМодели

Список моделей
client.beta.models.list(params?, options?): Page<BetaModelInfo>
GET/v1/models

Получите список доступных моделей.

Получить модель
client.beta.models.retrieve(modelID, params?, options?): BetaModelInfo
GET/v1/models/{model_id}

Получите конкретную модель.

Создать сообщение
client.beta.messages.create(params, options?): BetaMessage | Stream<BetaRawMessageStreamEvent>
POST/v1/messages

Отправьте структурированный список входных сообщений с текстом и/или изображениями, и модель сгенерирует следующее сообщение в разговоре.

Подсчитать токены в сообщении
client.beta.messages.countTokens(params, options?): BetaMessageTokensCount
POST/v1/messages/count_tokens

Подсчитайте количество токенов в сообщении.

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

Создать пакет сообщений
client.beta.messages.batches.create(params, options?): BetaMessageBatch
POST/v1/messages/batches

Отправьте пакет запросов на создание сообщений.

Получить пакет сообщений
client.beta.messages.batches.retrieve(messageBatchID, params?, options?): BetaMessageBatch
GET/v1/messages/batches/{message_batch_id}

Эта конечная точка идемпотентна и может использоваться для опроса завершения пакета сообщений. Чтобы получить доступ к результатам пакета сообщений, выполните запрос по адресу, указанному в поле results_url ответа.

Список пакетов сообщений
client.beta.messages.batches.list(params?, options?): Page<BetaMessageBatch>
GET/v1/messages/batches

Получите список всех пакетов сообщений в рабочем пространстве. Последние созданные пакеты возвращаются первыми.

Отменить пакет сообщений
client.beta.messages.batches.cancel(messageBatchID, params?, options?): BetaMessageBatch
POST/v1/messages/batches/{message_batch_id}/cancel

Пакеты можно отменить в любой момент до окончания обработки. После инициирования отмены пакет переходит в состояние canceling, в котором система может завершить все выполняющиеся непрерываемые запросы перед окончательной отменой.

Удалить пакет сообщений
client.beta.messages.batches.delete(messageBatchID, params?, options?): BetaDeletedMessageBatch
DELETE/v1/messages/batches/{message_batch_id}

Удалите пакет сообщений.

Получить результаты пакета сообщений
client.beta.messages.batches.results(messageBatchID, params?, options?): BetaMessageBatchIndividualResponse | Stream<BetaMessageBatchIndividualResponse>
GET/v1/messages/batches/{message_batch_id}/results

Передаёт результаты пакета сообщений в потоковом режиме в виде файла .jsonl.

БетаАгенты

Создать агента
client.beta.agents.create(params, options?): BetaManagedAgentsAgent
POST/v1/agents
Список агентов
client.beta.agents.list(params?, options?): PageCursor<BetaManagedAgentsAgent>
GET/v1/agents
Получить агента
client.beta.agents.retrieve(agentID, params?, options?): BetaManagedAgentsAgent
GET/v1/agents/{agent_id}
Обновить агента
client.beta.agents.update(agentID, params, options?): BetaManagedAgentsAgent
POST/v1/agents/{agent_id}
Архивировать агента
client.beta.agents.archive(agentID, params?, options?): BetaManagedAgentsAgent
POST/v1/agents/{agent_id}/archive

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

Список версий агента
client.beta.agents.versions.list(agentID, params?, options?): PageCursor<BetaManagedAgentsAgent>
GET/v1/agents/{agent_id}/versions

БетаСреды

Создать среду
client.beta.environments.create(params, options?): BetaEnvironment
POST/v1/environments

Создайте новую среду с указанной конфигурацией.

Список сред
client.beta.environments.list(params?, options?): PageCursor<BetaEnvironment>
GET/v1/environments

Получите список сред с поддержкой разбиения на страницы.

Получить среду
client.beta.environments.retrieve(environmentID, params?, options?): BetaEnvironment
GET/v1/environments/{environment_id}

Получите конкретную среду по идентификатору.

Обновить среду
client.beta.environments.update(environmentID, params, options?): BetaEnvironment
POST/v1/environments/{environment_id}

Обновите конфигурацию существующей среды.

Удалить среду
client.beta.environments.delete(environmentID, params?, options?): BetaEnvironmentDeleteResponse
DELETE/v1/environments/{environment_id}

Удалите среду по идентификатору. Возвращает подтверждение удаления.

Архивировать среду
client.beta.environments.archive(environmentID, params?, options?): BetaEnvironment
POST/v1/environments/{environment_id}/archive

Архивируйте среду по идентификатору. Архивированные среды нельзя использовать для создания новых сеансов.

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

Получить рабочий элемент
client.beta.environments.work.retrieve(workID, params, options?): BetaSelfHostedWork
GET/v1/environments/{environment_id}/work/{work_id}

Примечание: эти конечные точки вызываются автоматически готовым обработчиком среды (environment worker), входящим в состав SDK и CLI, для оркестрации сеансов с самостоятельно размещёнными изолированными средами (sandbox). Они приведены здесь для справки; вызывать их напрямую не требуется.

Опросить наличие работы
client.beta.environments.work.poll(environmentID, params?, options?): BetaSelfHostedWork | null
GET/v1/environments/{environment_id}/work/poll

Примечание: эти конечные точки вызываются автоматически готовым обработчиком среды (environment worker), входящим в состав SDK и CLI, для оркестрации сеансов с самостоятельно размещёнными изолированными средами (sandbox). Они приведены здесь для справки; вызывать их напрямую не требуется.

Подтвердить получение работы
client.beta.environments.work.ack(workID, params, options?): BetaSelfHostedWork
POST/v1/environments/{environment_id}/work/{work_id}/ack

Примечание: эти конечные точки вызываются автоматически готовым обработчиком среды (environment worker), входящим в состав SDK и CLI, для оркестрации сеансов с самостоятельно размещёнными изолированными средами (sandbox). Они приведены здесь для справки; вызывать их напрямую не требуется.

Записать сигнал активности
client.beta.environments.work.heartbeat(workID, params, options?): BetaSelfHostedWorkHeartbeatResponse
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat

Примечание: эти конечные точки вызываются автоматически готовым обработчиком среды (environment worker), входящим в состав SDK и CLI, для оркестрации сеансов с самостоятельно размещёнными изолированными средами (sandbox). Они приведены здесь для справки; вызывать их напрямую не требуется.

Остановить работу
client.beta.environments.work.stop(workID, params, options?): BetaSelfHostedWork
POST/v1/environments/{environment_id}/work/{work_id}/stop

Примечание: эти конечные точки вызываются автоматически готовым обработчиком среды (environment worker), входящим в состав SDK и CLI, для оркестрации сеансов с самостоятельно размещёнными изолированными средами (sandbox). Они приведены здесь для справки; вызывать их напрямую не требуется.

Список рабочих элементов
client.beta.environments.work.list(environmentID, params?, options?): PageCursor<BetaSelfHostedWork>
GET/v1/environments/{environment_id}/work

Примечание: эти конечные точки вызываются автоматически готовым обработчиком среды (environment worker), входящим в состав SDK и CLI, для оркестрации сеансов с самостоятельно размещёнными изолированными средами (sandbox). Они приведены здесь для справки; вызывать их напрямую не требуется.

Обновить рабочий элемент
client.beta.environments.work.update(workID, params, options?): BetaSelfHostedWork
POST/v1/environments/{environment_id}/work/{work_id}

Примечание: эти конечные точки вызываются автоматически готовым обработчиком среды (environment worker), входящим в состав SDK и CLI, для оркестрации сеансов с самостоятельно размещёнными изолированными средами (sandbox). Они приведены здесь для справки; вызывать их напрямую не требуется.

Получить статистику очереди
client.beta.environments.work.stats(environmentID, params?, options?): BetaSelfHostedWorkQueueStats
GET/v1/environments/{environment_id}/work/stats

Получите статистику очереди работ для среды.

БетаСеансы

Создать сеанс
client.beta.sessions.create(params, options?): BetaManagedAgentsSession
POST/v1/sessions
Список сеансов
client.beta.sessions.list(params?, options?): BidirectionalPageCursor<BetaManagedAgentsSession>
GET/v1/sessions
Получить сеанс
client.beta.sessions.retrieve(sessionID, params?, options?): BetaManagedAgentsSession
GET/v1/sessions/{session_id}
Обновить сеанс
client.beta.sessions.update(sessionID, params, options?): BetaManagedAgentsSession
POST/v1/sessions/{session_id}
Удалить сеанс
client.beta.sessions.delete(sessionID, params?, options?): BetaManagedAgentsDeletedSession
DELETE/v1/sessions/{session_id}
Архивировать сеанс
client.beta.sessions.archive(sessionID, params?, options?): BetaManagedAgentsSession
POST/v1/sessions/{session_id}/archive

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

Список событий
client.beta.sessions.events.list(sessionID, params?, options?): PageCursor<BetaManagedAgentsSessionEvent>
GET/v1/sessions/{session_id}/events
Отправить события
client.beta.sessions.events.send(sessionID, params, options?): BetaManagedAgentsSendSessionEvents
POST/v1/sessions/{session_id}/events
Потоковая передача событий
client.beta.sessions.events.stream(sessionID, params?, options?): BetaManagedAgentsStreamSessionEvents | Stream<BetaManagedAgentsStreamSessionEvents>
GET/v1/sessions/{session_id}/events/stream

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

Добавить ресурс сеанса
client.beta.sessions.resources.add(sessionID, params, options?): BetaManagedAgentsFileResource
POST/v1/sessions/{session_id}/resources
Список ресурсов сеанса
client.beta.sessions.resources.list(sessionID, params?, options?): PageCursor<BetaManagedAgentsSessionResource>
GET/v1/sessions/{session_id}/resources
Получить ресурс сеанса
client.beta.sessions.resources.retrieve(resourceID, params, options?): ResourceRetrieveResponse
GET/v1/sessions/{session_id}/resources/{resource_id}
Обновить ресурс сеанса
client.beta.sessions.resources.update(resourceID, params, options?): ResourceUpdateResponse
POST/v1/sessions/{session_id}/resources/{resource_id}
Удалить ресурс сеанса
client.beta.sessions.resources.delete(resourceID, params, options?): BetaManagedAgentsDeleteSessionResource
DELETE/v1/sessions/{session_id}/resources/{resource_id}

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

Список потоков сеанса
client.beta.sessions.threads.list(sessionID, params?, options?): PageCursor<BetaManagedAgentsSessionThread>
GET/v1/sessions/{session_id}/threads
Получить поток сеанса
client.beta.sessions.threads.retrieve(threadID, params, options?): BetaManagedAgentsSessionThread
GET/v1/sessions/{session_id}/threads/{thread_id}
Архивировать поток сеанса
client.beta.sessions.threads.archive(threadID, params, options?): BetaManagedAgentsSessionThread
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

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

Список событий потока сеанса
client.beta.sessions.threads.events.list(threadID, params, options?): PageCursor<BetaManagedAgentsSessionEvent>
GET/v1/sessions/{session_id}/threads/{thread_id}/events
Потоковая передача событий потока сеанса
client.beta.sessions.threads.events.stream(threadID, params, options?): BetaManagedAgentsStreamSessionThreadEvents | Stream<BetaManagedAgentsStreamSessionThreadEvents>
GET/v1/sessions/{session_id}/threads/{thread_id}/stream
Создать развёртывание
client.beta.deployments.create(params, options?): BetaManagedAgentsDeployment
POST/v1/deployments
Список развёртываний
client.beta.deployments.list(params?, options?): PageCursor<BetaManagedAgentsDeployment>
GET/v1/deployments
Получить развёртывание
client.beta.deployments.retrieve(deploymentID, params?, options?): BetaManagedAgentsDeployment
GET/v1/deployments/{deployment_id}
Обновить развёртывание
client.beta.deployments.update(deploymentID, params, options?): BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}
Архивировать развёртывание
client.beta.deployments.archive(deploymentID, params?, options?): BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}/archive
Запустить развёртывание сейчас
client.beta.deployments.run(deploymentID, params?, options?): BetaManagedAgentsDeploymentRun
POST/v1/deployments/{deployment_id}/run
Приостановить развёртывание
client.beta.deployments.pause(deploymentID, params?, options?): BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}/pause
Возобновить развёртывание
client.beta.deployments.unpause(deploymentID, params?, options?): BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}/unpause
Список запусков развёртывания
client.beta.deploymentRuns.list(params?, options?): PageCursor<BetaManagedAgentsDeploymentRun>
GET/v1/deployment_runs
Получить запуск развёртывания
client.beta.deploymentRuns.retrieve(deploymentRunID, params?, options?): BetaManagedAgentsDeploymentRun
GET/v1/deployment_runs/{deployment_run_id}

БетаСейфы

Создать сейф
client.beta.vaults.create(params, options?): BetaManagedAgentsVault
POST/v1/vaults
Список сейфов
client.beta.vaults.list(params?, options?): PageCursor<BetaManagedAgentsVault>
GET/v1/vaults
Получить сейф
client.beta.vaults.retrieve(vaultID, params?, options?): BetaManagedAgentsVault
GET/v1/vaults/{vault_id}
Обновить сейф
client.beta.vaults.update(vaultID, params, options?): BetaManagedAgentsVault
POST/v1/vaults/{vault_id}
Удалить сейф
client.beta.vaults.delete(vaultID, params?, options?): BetaManagedAgentsDeletedVault
DELETE/v1/vaults/{vault_id}
Архивировать сейф
client.beta.vaults.archive(vaultID, params?, options?): BetaManagedAgentsVault
POST/v1/vaults/{vault_id}/archive

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

Создать учётные данные
client.beta.vaults.credentials.create(vaultID, params, options?): BetaManagedAgentsCredential
POST/v1/vaults/{vault_id}/credentials
Список учётных данных
client.beta.vaults.credentials.list(vaultID, params?, options?): PageCursor<BetaManagedAgentsCredential>
GET/v1/vaults/{vault_id}/credentials
Получить учётные данные
client.beta.vaults.credentials.retrieve(credentialID, params, options?): BetaManagedAgentsCredential
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Обновить учётные данные
client.beta.vaults.credentials.update(credentialID, params, options?): BetaManagedAgentsCredential
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Удалить учётные данные
client.beta.vaults.credentials.delete(credentialID, params, options?): BetaManagedAgentsDeletedCredential
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Архивировать учётные данные
client.beta.vaults.credentials.archive(credentialID, params, options?): BetaManagedAgentsCredential
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Проверить учётные данные
client.beta.vaults.credentials.mcpOAuthValidate(credentialID, params, options?): BetaManagedAgentsCredentialValidation
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate
Создать хранилище памяти
client.beta.memoryStores.create(params, options?): BetaManagedAgentsMemoryStore
POST/v1/memory_stores
Список хранилищ памяти
client.beta.memoryStores.list(params?, options?): PageCursor<BetaManagedAgentsMemoryStore>
GET/v1/memory_stores
Получить хранилище памяти
client.beta.memoryStores.retrieve(memoryStoreID, params?, options?): BetaManagedAgentsMemoryStore
GET/v1/memory_stores/{memory_store_id}
Обновить хранилище памяти
client.beta.memoryStores.update(memoryStoreID, params, options?): BetaManagedAgentsMemoryStore
POST/v1/memory_stores/{memory_store_id}
Удалить хранилище памяти
client.beta.memoryStores.delete(memoryStoreID, params?, options?): BetaManagedAgentsDeletedMemoryStore
DELETE/v1/memory_stores/{memory_store_id}
Архивировать хранилище памяти
client.beta.memoryStores.archive(memoryStoreID, params?, options?): BetaManagedAgentsMemoryStore
POST/v1/memory_stores/{memory_store_id}/archive

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

Создать запись памяти
client.beta.memoryStores.memories.create(memoryStoreID, params, options?): BetaManagedAgentsMemory
POST/v1/memory_stores/{memory_store_id}/memories
Список записей памяти
client.beta.memoryStores.memories.list(memoryStoreID, params?, options?): PageCursor<BetaManagedAgentsMemoryListItem>
GET/v1/memory_stores/{memory_store_id}/memories
Получить запись памяти
client.beta.memoryStores.memories.retrieve(memoryID, params, options?): BetaManagedAgentsMemory
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Обновить запись памяти
client.beta.memoryStores.memories.update(memoryID, params, options?): BetaManagedAgentsMemory
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Удалить запись памяти
client.beta.memoryStores.memories.delete(memoryID, params, options?): BetaManagedAgentsDeletedMemory
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}

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

Список версий записи памяти
client.beta.memoryStores.memoryVersions.list(memoryStoreID, params?, options?): PageCursor<BetaManagedAgentsMemoryVersion>
GET/v1/memory_stores/{memory_store_id}/memory_versions
Получить версию записи памяти
client.beta.memoryStores.memoryVersions.retrieve(memoryVersionID, params, options?): BetaManagedAgentsMemoryVersion
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
Скрыть содержимое версии записи памяти
client.beta.memoryStores.memoryVersions.redact(memoryVersionID, params, options?): BetaManagedAgentsMemoryVersion
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

БетаФайлы

Загрузить файл
client.beta.files.upload(params, options?): BetaFileMetadata
POST/v1/files
Список файлов
client.beta.files.list(params?, options?): PageCursor<BetaFileMetadata>
GET/v1/files
Скачать файл
client.beta.files.download(fileID, params?, options?): Response
GET/v1/files/{file_id}/content
Получить метаданные файла
client.beta.files.retrieveMetadata(fileID, params?, options?): BetaFileMetadata
GET/v1/files/{file_id}
Удалить файл
client.beta.files.delete(fileID, params?, options?): BetaDeletedFile
DELETE/v1/files/{file_id}

БетаНавыки

Создать навык
client.beta.skills.create(params, options?): BetaSkill
POST/v1/skills
Список навыков
client.beta.skills.list(params?, options?): PageCursor<BetaSkill>
GET/v1/skills
Получить навык
client.beta.skills.retrieve(skillID, params?, options?): BetaSkill
GET/v1/skills/{skill_id}
Удалить навык
client.beta.skills.delete(skillID, params?, options?): BetaDeletedSkill
DELETE/v1/skills/{skill_id}

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

Создать версию навыка
client.beta.skills.versions.create(skillID, params, options?): BetaSkillVersion
POST/v1/skills/{skill_id}/versions
Список версий навыка
client.beta.skills.versions.list(skillID, params?, options?): PageCursor<BetaSkillVersion>
GET/v1/skills/{skill_id}/versions
Скачать содержимое версии навыка
client.beta.skills.versions.download(version, params, options?): Response
GET/v1/skills/{skill_id}/versions/{version}/content

Скачивает содержимое версии навыка в виде zip-архива.

Получить версию навыка
client.beta.skills.versions.retrieve(version, params, options?): BetaSkillVersion
GET/v1/skills/{skill_id}/versions/{version}
Удалить версию навыка
client.beta.skills.versions.delete(version, params, options?): BetaDeletedSkillVersion
DELETE/v1/skills/{skill_id}/versions/{version}
Создать профиль пользователя
client.beta.userProfiles.create(params, options?): BetaUserProfile
POST/v1/user_profiles
Список профилей пользователей
client.beta.userProfiles.list(params?, options?): PageCursor<BetaUserProfile>
GET/v1/user_profiles
Получить профиль пользователя
client.beta.userProfiles.retrieve(userProfileID, params?, options?): BetaUserProfile
GET/v1/user_profiles/{user_profile_id}
Обновить профиль пользователя
client.beta.userProfiles.update(userProfileID, params, options?): BetaUserProfile
POST/v1/user_profiles/{user_profile_id}
Создать URL регистрации
client.beta.userProfiles.createEnrollmentURL(userProfileID, params?, options?): BetaUserProfileEnrollmentURL
POST/v1/user_profiles/{user_profile_id}/enrollment_url

БетаСны

Создать сон
client.beta.dreams.create(params, options?): BetaDream
POST/v1/dreams

Запускает асинхронное задание, которое использует прошлые сеансы для создания реорганизованной версии хранилища памяти, и возвращает «dream» (сон), который можно опрашивать для получения результата.

Список снов
client.beta.dreams.list(params?, options?): PageCursor<BetaDream>
GET/v1/dreams

Возвращает список снов в рабочей области, начиная с самых новых.

Получить сон
client.beta.dreams.retrieve(dreamID, params?, options?): BetaDream
GET/v1/dreams/{dream_id}

Получает сон по ID, чтобы проверить его статус, выходное хранилище памяти и использование токенов.

Отменить сон
client.beta.dreams.cancel(dreamID, params?, options?): BetaDream
POST/v1/dreams/{dream_id}/cancel

Останавливает сон в состоянии pending или running.

Архивировать сон
client.beta.dreams.archive(dreamID, params?, options?): BetaDream
POST/v1/dreams/{dream_id}/archive

Скрывает сон в состоянии completed, failed или canceled из списка снов по умолчанию.

БетаТуннели

Создать туннель
client.beta.tunnels.create(params, options?): BetaTunnel
POST/v1/tunnels

API Tunnels находится на стадии исследовательской предварительной версии (research preview). Для него требуется заголовок anthropic-beta: mcp-tunnels-2026-06-22, и он может измениться без периода устаревания. Он заменяет конечные точки Admin API по адресу /v1/organizations/tunnels, которые остаются доступными в течение переходного периода.

Получить туннель
client.beta.tunnels.retrieve(tunnelID, params?, options?): BetaTunnel
GET/v1/tunnels/{tunnel_id}

API Tunnels находится на стадии исследовательской предварительной версии (research preview). Для него требуется заголовок anthropic-beta: mcp-tunnels-2026-06-22, и он может измениться без периода устаревания. Он заменяет конечные точки Admin API по адресу /v1/organizations/tunnels, которые остаются доступными в течение переходного периода.

Список туннелей
client.beta.tunnels.list(params?, options?): PageCursor<BetaTunnel>
GET/v1/tunnels

API Tunnels находится на стадии исследовательской предварительной версии (research preview). Для него требуется заголовок anthropic-beta: mcp-tunnels-2026-06-22, и он может измениться без периода устаревания. Он заменяет конечные точки Admin API по адресу /v1/organizations/tunnels, которые остаются доступными в течение переходного периода.

Архивировать туннель
client.beta.tunnels.archive(tunnelID, params?, options?): BetaTunnel
POST/v1/tunnels/{tunnel_id}/archive

API Tunnels находится на стадии исследовательской предварительной версии (research preview). Для него требуется заголовок anthropic-beta: mcp-tunnels-2026-06-22, и он может измениться без периода устаревания. Он заменяет конечные точки Admin API по адресу /v1/organizations/tunnels, которые остаются доступными в течение переходного периода.

Показать токен туннеля
client.beta.tunnels.revealToken(tunnelID, params?, options?): BetaTunnelToken
POST/v1/tunnels/{tunnel_id}/reveal_token

API Tunnels находится на стадии исследовательской предварительной версии (research preview). Для него требуется заголовок anthropic-beta: mcp-tunnels-2026-06-22, и он может измениться без периода устаревания. Он заменяет конечные точки Admin API по адресу /v1/organizations/tunnels, которые остаются доступными в течение переходного периода.

Ротация токена туннеля
client.beta.tunnels.rotateToken(tunnelID, params, options?): BetaTunnelToken
POST/v1/tunnels/{tunnel_id}/rotate_token

API Tunnels находится на стадии исследовательской предварительной версии (research preview). Для него требуется заголовок anthropic-beta: mcp-tunnels-2026-06-22, и он может измениться без периода устаревания. Он заменяет конечные точки Admin API по адресу /v1/organizations/tunnels, которые остаются доступными в течение переходного периода.

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

Создать сертификат туннеля
client.beta.tunnels.certificates.create(tunnelID, params, options?): BetaTunnelCertificate
POST/v1/tunnels/{tunnel_id}/certificates

API Tunnels находится на стадии исследовательской предварительной версии (research preview). Для него требуется заголовок anthropic-beta: mcp-tunnels-2026-06-22, и он может измениться без периода устаревания. Он заменяет конечные точки Admin API по адресу /v1/organizations/tunnels, которые остаются доступными в течение переходного периода.

Получить сертификат туннеля
client.beta.tunnels.certificates.retrieve(certificateID, params, options?): BetaTunnelCertificate
GET/v1/tunnels/{tunnel_id}/certificates/{certificate_id}

API Tunnels находится на стадии исследовательской предварительной версии (research preview). Для него требуется заголовок anthropic-beta: mcp-tunnels-2026-06-22, и он может измениться без периода устаревания. Он заменяет конечные точки Admin API по адресу /v1/organizations/tunnels, которые остаются доступными в течение переходного периода.

Список сертификатов туннеля
client.beta.tunnels.certificates.list(tunnelID, params?, options?): PageCursor<BetaTunnelCertificate>
GET/v1/tunnels/{tunnel_id}/certificates

API Tunnels находится на стадии исследовательской предварительной версии (research preview). Для него требуется заголовок anthropic-beta: mcp-tunnels-2026-06-22, и он может измениться без периода устаревания. Он заменяет конечные точки Admin API по адресу /v1/organizations/tunnels, которые остаются доступными в течение переходного периода.

Архивировать сертификат туннеля
client.beta.tunnels.certificates.archive(certificateID, params, options?): BetaTunnelCertificate
POST/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

API Tunnels находится на стадии исследовательской предварительной версии (research preview). Для него требуется заголовок anthropic-beta: mcp-tunnels-2026-06-22, и он может измениться без периода устаревания. Он заменяет конечные точки Admin API по адресу /v1/organizations/tunnels, которые остаются доступными в течение переходного периода.

Получить текущую организацию
client.beta.organization.retrieve(options?): BetaOrganization
GET/v1/organizations/me

Возвращает информацию об организации, связанной с аутентифицированным ключом API.

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

Список ключей API
client.beta.organization.apiKeys.list(query?, options?): Page<BetaAPIKey>
GET/v1/organizations/api_keys
Получить ключ API (Admin API)
client.beta.organization.apiKeys.retrieve(apiKeyID, options?): BetaAPIKey
GET/v1/organizations/api_keys/{api_key_id}

Возвращает информацию об одном ключе API в вашей организации по его идентификатору. Эта конечная точка Admin API требует ключа Admin API, предназначена для программного управления ключами и никогда не возвращает секретное значение ключа. Чтобы просмотреть или создать собственные ключи API, перейдите в раздел Ключи API в Claude Console.

Обновить ключ API
client.beta.organization.apiKeys.update(apiKeyID, body, options?): BetaAPIKey
POST/v1/organizations/api_keys/{api_key_id}

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

Создать внешний ключ
client.beta.organization.externalKeys.create(body, options?): BetaExternalKey
POST/v1/organizations/external_keys

Создаёт конфигурацию внешнего ключа, принадлежащую организации вызывающей стороны.

Список внешних ключей
client.beta.organization.externalKeys.list(query?, options?): PageCursor<BetaExternalKey>
GET/v1/organizations/external_keys

Возвращает список конфигураций внешних ключей в организации вызывающей стороны.

Получить внешний ключ
client.beta.organization.externalKeys.retrieve(externalKeyID, options?): BetaExternalKey
GET/v1/organizations/external_keys/{external_key_id}

Возвращает одну конфигурацию внешнего ключа в организации вызывающей стороны по идентификатору.

Обновить внешний ключ
client.beta.organization.externalKeys.update(externalKeyID, body, options?): BetaExternalKey
POST/v1/organizations/external_keys/{external_key_id}

Частично обновляет конфигурацию внешнего ключа. Пропущенные поля остаются без изменений.

Удалить внешний ключ
client.beta.organization.externalKeys.delete(externalKeyID, options?): ExternalKeyDeleteResponse
DELETE/v1/organizations/external_keys/{external_key_id}

Удаляет конфигурацию внешнего ключа.

Проверить внешний ключ
client.beta.organization.externalKeys.validate(externalKeyID, options?): ExternalKeyValidateResponse
POST/v1/organizations/external_keys/{external_key_id}/validate

Проверяет конфигурацию внешнего ключа в KMS клиента.

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

Создать издателя федерации
client.beta.organization.federation.issuers.create(params, options?): BetaFederationIssuer
POST/v1/organizations/federation_issuers

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Список издателей федерации
client.beta.organization.federation.issuers.list(params?, options?): PageCursor<BetaFederationIssuer>
GET/v1/organizations/federation_issuers

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Получить издателя федерации
client.beta.organization.federation.issuers.retrieve(federationIssuerID, params?, options?): BetaFederationIssuer
GET/v1/organizations/federation_issuers/{federation_issuer_id}

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Обновить издателя федерации
client.beta.organization.federation.issuers.update(federationIssuerID, params, options?): BetaFederationIssuer
POST/v1/organizations/federation_issuers/{federation_issuer_id}

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Архивировать издателя федерации
client.beta.organization.federation.issuers.archive(federationIssuerID, params?, options?): BetaFederationIssuer
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

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

Создать правило федерации
client.beta.organization.federation.rules.create(params, options?): BetaFederationRule
POST/v1/organizations/federation_rules

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Список правил федерации
client.beta.organization.federation.rules.list(params?, options?): PageCursor<BetaFederationRule>
GET/v1/organizations/federation_rules

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Получить правило федерации
client.beta.organization.federation.rules.retrieve(federationRuleID, params?, options?): BetaFederationRule
GET/v1/organizations/federation_rules/{federation_rule_id}

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Обновить правило федерации
client.beta.organization.federation.rules.update(federationRuleID, params, options?): BetaFederationRule
POST/v1/organizations/federation_rules/{federation_rule_id}

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Архивировать правило федерации
client.beta.organization.federation.rules.archive(federationRuleID, params?, options?): BetaFederationRule
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

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

Добавить рабочее пространство в правило федерации
client.beta.organization.federation.rules.workspaces.add(federationRuleID, params, options?): BetaFederationRuleWorkspace
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Список рабочих пространств правила федерации
client.beta.organization.federation.rules.workspaces.list(federationRuleID, params?, options?): PageCursor<BetaFederationRuleWorkspace>
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Удалить рабочее пространство из правила федерации
client.beta.organization.federation.rules.workspaces.remove(workspaceID, params, options?): WorkspaceRemoveResponse
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

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

Создать приглашение
client.beta.organization.invites.create(body, options?): BetaOrganizationInvite
POST/v1/organizations/invites

Приглашает пользователя присоединиться к организации по электронной почте.

Список приглашений
client.beta.organization.invites.list(query?, options?): Page<BetaOrganizationInvite>
GET/v1/organizations/invites

Возвращает список приглашений организации.

Получить приглашение
client.beta.organization.invites.retrieve(inviteID, options?): BetaOrganizationInvite
GET/v1/organizations/invites/{invite_id}

Возвращает приглашение по идентификатору.

Удалить приглашение
client.beta.organization.invites.delete(inviteID, options?): InviteDeleteResponse
DELETE/v1/organizations/invites/{invite_id}

Удаляет ожидающее приглашение.

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

Создать сервисный аккаунт
client.beta.organization.serviceAccounts.create(params, options?): BetaServiceAccount
POST/v1/organizations/service_accounts

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Список сервисных аккаунтов
client.beta.organization.serviceAccounts.list(params?, options?): PageCursor<BetaServiceAccount>
GET/v1/organizations/service_accounts

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Получить сервисный аккаунт
client.beta.organization.serviceAccounts.retrieve(serviceAccountID, params?, options?): BetaServiceAccount
GET/v1/organizations/service_accounts/{service_account_id}

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Обновить сервисный аккаунт
client.beta.organization.serviceAccounts.update(serviceAccountID, params, options?): BetaServiceAccount
POST/v1/organizations/service_accounts/{service_account_id}

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Архивировать сервисный аккаунт
client.beta.organization.serviceAccounts.archive(serviceAccountID, params?, options?): BetaServiceAccount
POST/v1/organizations/service_accounts/{service_account_id}/archive

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

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

Добавить рабочее пространство в сервисный аккаунт
client.beta.organization.serviceAccounts.workspaces.add(serviceAccountID, params, options?): BetaServiceAccountWorkspaceMember
POST/v1/organizations/service_accounts/{service_account_id}/workspaces

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Список рабочих пространств сервисного аккаунта
client.beta.organization.serviceAccounts.workspaces.list(serviceAccountID, params?, options?): PageCursor<BetaServiceAccountWorkspaceMember>
GET/v1/organizations/service_accounts/{service_account_id}/workspaces

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Удалить рабочее пространство из сервисного аккаунта
client.beta.organization.serviceAccounts.workspaces.remove(workspaceID, params, options?): WorkspaceRemoveResponse
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

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

Список пользователей
client.beta.organization.users.list(query?, options?): Page<BetaOrganizationUser>
GET/v1/organizations/users

Возвращает список участников организации.

Получить пользователя
client.beta.organization.users.retrieve(userID, options?): BetaOrganizationUser
GET/v1/organizations/users/{user_id}

Возвращает участника организации по идентификатору пользователя.

Обновить пользователя
client.beta.organization.users.update(userID, body, options?): BetaOrganizationUser
POST/v1/organizations/users/{user_id}

Обновляет роль участника в организации.

Удалить пользователя
client.beta.organization.users.remove(userID, options?): UserRemoveResponse
DELETE/v1/organizations/users/{user_id}

Удаляет участника из организации.

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

Список рабочих пространств
client.beta.organization.workspaces.list(query?, options?): Page<BetaWorkspace>
GET/v1/organizations/workspaces
Создать рабочее пространство
client.beta.organization.workspaces.create(params, options?): BetaWorkspace
POST/v1/organizations/workspaces
Получить рабочее пространство
client.beta.organization.workspaces.retrieve(workspaceID, options?): BetaWorkspace
GET/v1/organizations/workspaces/{workspace_id}
Обновить рабочее пространство
client.beta.organization.workspaces.update(workspaceID, body, options?): BetaWorkspace
POST/v1/organizations/workspaces/{workspace_id}
Архивировать рабочее пространство
client.beta.organization.workspaces.archive(workspaceID, options?): BetaWorkspace
POST/v1/organizations/workspaces/{workspace_id}/archive

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

Список ограничений скорости рабочего пространства
client.beta.organization.workspaces.rateLimits.list(workspaceID, query?, options?): PageCursor<BetaWorkspaceRateLimit>
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

Возвращает список ограничений скорости рабочего пространства.

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

Список участников рабочего пространства
client.beta.organization.workspaces.members.list(workspaceID, query?, options?): Page<BetaWorkspaceMember>
GET/v1/organizations/workspaces/{workspace_id}/members
Создать участника рабочего пространства
client.beta.organization.workspaces.members.add(workspaceID, body, options?): BetaWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members
Получить участника рабочего пространства
client.beta.organization.workspaces.members.retrieve(userID, params, options?): BetaWorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Обновить участника рабочего пространства
client.beta.organization.workspaces.members.update(userID, params, options?): BetaWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Удалить участника рабочего пространства
client.beta.organization.workspaces.members.remove(userID, params, options?): MemberRemoveResponse
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

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

Список сервисных аккаунтов — участников рабочего пространства
client.beta.organization.workspaces.serviceAccounts.list(workspaceID, params?, options?): PageCursor<BetaServiceAccountWorkspaceMember>
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Добавить сервисный аккаунт в рабочее пространство
client.beta.organization.workspaces.serviceAccounts.add(workspaceID, params, options?): BetaServiceAccountWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Получить членство сервисного аккаунта в рабочем пространстве
client.beta.organization.workspaces.serviceAccounts.retrieve(serviceAccountID, params, options?): BetaServiceAccountWorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Обновить членство сервисного аккаунта в рабочем пространстве
client.beta.organization.workspaces.serviceAccounts.update(serviceAccountID, params, options?): BetaServiceAccountWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Удалить сервисный аккаунт из рабочего пространства
client.beta.organization.workspaces.serviceAccounts.remove(serviceAccountID, params, options?): ServiceAccountRemoveResponse
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

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

Список ограничений скорости организации
client.beta.organization.rateLimits.list(query?, options?): PageCursor<BetaOrganizationRateLimit>
GET/v1/organizations/rate_limits

Список ограничений скорости Messages API для вашей организации.

Получение настроек соответствия требованиям
client.beta.organization.complianceSettings.retrieve(options?): BetaComplianceSettings
GET/v1/organizations/compliance_settings

Получение настроек соответствия требованиям (Compliance Settings) вашей организации.

Обновление настроек соответствия требованиям
client.beta.organization.complianceSettings.update(body, options?): BetaComplianceSettings
POST/v1/organizations/compliance_settings

Обновление настроек соответствия требованиям (Compliance Settings) вашей организации.

БетаОрганизацияАналитикаСводки

Получение сводок активности
client.beta.organization.analytics.summaries.list(query, options?): PageCursor<BetaAnalyticsSingleDayActivitySummary>
GET/v1/organizations/analytics/summaries

Получает сводки активности по всей организации за диапазон дат.

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

Список активности пользователей
client.beta.organization.analytics.users.list(query?, options?): PageCursor<BetaAnalyticsUserActivity>
GET/v1/organizations/analytics/users

Получить активность по пользователям за указанный день с курсорной пагинацией.

БетаОрганизацияАналитикаПриложенияЧатПроекты

Получение данных об использовании проектов чата
client.beta.organization.analytics.apps.chat.projects.list(query?, options?): PageCursor<BetaAnalyticsProjectActivity>
GET/v1/organizations/analytics/apps/chat/projects

Получает активность по каждому проекту за указанный день с пагинацией на основе курсора.

БетаОрганизацияАналитикаКоннекторы

Получить использование коннекторов
client.beta.organization.analytics.connectors.list(query?, options?): PageCursor<BetaAnalyticsConnectorActivity>
GET/v1/organizations/analytics/connectors

Получить использование по коннекторам за указанный день с курсорной пагинацией.

БетаОрганизацияАналитикаПлагины

Получить использование плагинов
client.beta.organization.analytics.plugins.list(query?, options?): PageCursor<BetaAnalyticsPluginActivity>
GET/v1/organizations/analytics/plugins

Получить использование по плагинам (установки + вызовы) за указанный день с пагинацией.

БетаОрганизацияАналитикаНавыки

Получить использование навыков
client.beta.organization.analytics.skills.list(query?, options?): PageCursor<BetaAnalyticsSkillActivity>
GET/v1/organizations/analytics/skills

Получить использование по навыкам за указанный день с курсорной пагинацией.

БетаОрганизацияАналитикаArtifacts

Получить активность по Artifacts
client.beta.organization.analytics.artifacts.list(query, options?): PageCursor<BetaAnalyticsArtifactActivity>
GET/v1/organizations/analytics/artifacts

Получить активность создания Artifacts за указанный день с разбивкой по MIME-типу.

БетаОрганизацияАналитикаОтчёт об использовании

Получение использования токенов во времени
client.beta.organization.analytics.usageReport.list(query, options?): PageCursor<BetaAnalyticsUsageReportTimeBucket>
GET/v1/organizations/analytics/usage_report

Получает данные об использовании токенов во времени за диапазон дат.

БетаОрганизацияАналитикаОтчёт об использовании по пользователям

Получение использования токенов по пользователям
client.beta.organization.analytics.userUsageReport.list(query, options?): PageCursor<BetaAnalyticsUsageUsersItem>
GET/v1/organizations/analytics/user_usage_report

Получает данные об использовании токенов по каждому пользователю за диапазон дат.

БетаОрганизацияАналитикаОтчёт о затратах

Получение затрат во времени
client.beta.organization.analytics.costReport.list(query, options?): PageCursor<BetaAnalyticsCostReportTimeBucket>
GET/v1/organizations/analytics/cost_report

Получает затраты в долларах США во времени за диапазон дат.

БетаОрганизацияАналитикаОтчёт о затратах по пользователям

Получение затрат по пользователям
client.beta.organization.analytics.userCostReport.list(query, options?): PageCursor<BetaAnalyticsCostUsersItem>
GET/v1/organizations/analytics/user_cost_report

Получает затраты в долларах США по каждому пользователю за диапазон дат.

БетаОрганизацияЛимиты расходов

Установка лимита расходов
client.beta.organization.spendLimits.set(params, options?): BetaSpendLimit
POST/v1/organizations/spend_limits

Устанавливает лимит расходов.

Получить лимит расходов
client.beta.organization.spendLimits.retrieve(spendLimitID, options?): BetaSpendLimit
GET/v1/organizations/spend_limits/{spend_limit_id}

Получить лимит расходов по ID.

Удалить лимит расходов
client.beta.organization.spendLimits.delete(spendLimitID, options?): SpendLimitDeleteResponse
DELETE/v1/organizations/spend_limits/{spend_limit_id}

Удаление лимита расходов.

Список лимитов расходов
client.beta.organization.spendLimits.list(params?, options?): PageCursor<BetaSpendLimit>
GET/v1/organizations/spend_limits

Возвращает список "spend limits" (лимитов расходов) организации.

БетаОрганизацияЛимиты расходовДействующие

Список действующих лимитов расходов
client.beta.organization.spendLimits.effective.list(query?, options?): PageCursor<BetaSpendSummary>
GET/v1/organizations/spend_limits/effective

Возвращает действующий лимит расходов и расходы с начала периода для каждого участника.

БетаОрганизацияЛимиты расходовЗапросы на увеличение

Список запросов на увеличение лимита расходов
client.beta.organization.spendLimits.increaseRequests.list(query?, options?): PageCursor<BetaSpendLimitIncreaseRequest>
GET/v1/organizations/spend_limit_increase_requests

Список запросов на увеличение лимита расходов, сначала самые последние.

Получить запрос на увеличение лимита расходов
client.beta.organization.spendLimits.increaseRequests.retrieve(spendLimitIncreaseRequestID, options?): BetaSpendLimitIncreaseRequest
GET/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}
Одобрить запрос на увеличение лимита расходов
client.beta.organization.spendLimits.increaseRequests.approve(spendLimitIncreaseRequestID, body, options?): IncreaseRequestApproveResponse
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve

Одобрить ожидающий запрос на увеличение лимита расходов.

Отклонить запрос на увеличение лимита расходов
client.beta.organization.spendLimits.increaseRequests.deny(spendLimitIncreaseRequestID, body, options?): BetaSpendLimitIncreaseRequest
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny

Отклонить ожидающий запрос на увеличение лимита расходов.

БетаОрганизацияГруппы RBAC

Создать группу RBAC
client.beta.organization.rbacGroups.create(body, options?): BetaRBACGroup
POST/v1/organizations/rbac_groups

Создать группу RBAC в тенанте Claude Enterprise. Группы, созданные через API, имеют тип источника "direct".

Список групп RBAC
client.beta.organization.rbacGroups.list(query?, options?): PageCursor<BetaRBACGroup>
GET/v1/organizations/rbac_groups

Получить список групп RBAC в тенанте Claude Enterprise.

Получить группу RBAC
client.beta.organization.rbacGroups.retrieve(rbacGroupID, options?): BetaRBACGroup
GET/v1/organizations/rbac_groups/{rbac_group_id}

Получить группу RBAC по ID.

Обновить группу RBAC
client.beta.organization.rbacGroups.update(rbacGroupID, body, options?): BetaRBACGroup
POST/v1/organizations/rbac_groups/{rbac_group_id}

Обновляет название группы RBAC. Группы, подготовленные поставщиком удостоверений (тип источника "scim"), нельзя изменить через API, пока организация в тенанте использует подготовку SCIM.

Удалить группу RBAC
client.beta.organization.rbacGroups.delete(rbacGroupID, options?): RBACGroupDeleteResponse
DELETE/v1/organizations/rbac_groups/{rbac_group_id}

Удаляет группу RBAC. Группы, подготовленные поставщиком удостоверений (тип источника "scim"), нельзя удалить через API, пока организация в тенанте использует подготовку SCIM.

БетаОрганизацияГруппы RBACУчастники

Список участников группы RBAC
client.beta.organization.rbacGroups.members.list(rbacGroupID, query?, options?): PageCursor<BetaRBACGroupMember>
GET/v1/organizations/rbac_groups/{rbac_group_id}/members

Получить список участников группы RBAC.

Добавление участника в группу RBAC
client.beta.organization.rbacGroups.members.add(rbacGroupID, body, options?): BetaRBACGroupMember
POST/v1/organizations/rbac_groups/{rbac_group_id}/members

Добавляет пользователя в группу RBAC. Состав групп, подготовленных поставщиком удостоверений (тип источника "scim"), нельзя изменить через API, пока организация в клиенте использует подготовку SCIM.

Удаление участника из группы RBAC
client.beta.organization.rbacGroups.members.remove(userID, params, options?): MemberRemoveResponse
DELETE/v1/organizations/rbac_groups/{rbac_group_id}/members/{user_id}

Удаляет пользователя из группы RBAC. Состав групп, подготовленных поставщиком удостоверений (тип источника "scim"), нельзя изменить через API, пока организация в клиенте использует подготовку SCIM.

БетаОрганизацияРоли RBAC

Список ролей RBAC
client.beta.organization.rbacRoles.list(query?, options?): PageCursor<BetaRBACRole>
GET/v1/organizations/rbac_roles

Получить список ролей RBAC в организации.

Получить роль RBAC
client.beta.organization.rbacRoles.retrieve(rbacRoleID, options?): BetaRBACRole
GET/v1/organizations/rbac_roles/{rbac_role_id}

Получить роль RBAC по ID.

БетаОрганизацияРоли RBACРазрешения

Список разрешений роли RBAC
client.beta.organization.rbacRoles.permissions.list(rbacRoleID, query?, options?): PageCursor<BetaRBACRolePermission>
GET/v1/organizations/rbac_roles/{rbac_role_id}/permissions

Получить список разрешений, предоставляемых ролью RBAC.

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

Создание плагина
client.beta.organization.plugins.create(params, options?): BetaPlugin
POST/v1/organizations/plugins

Создаёт плагин, принадлежащий организации, и его первую версию путём загрузки файлов версии.

Получение плагина
client.beta.organization.plugins.retrieve(pluginID, params?, options?): BetaPlugin
GET/v1/organizations/plugins/{plugin_id}

Получает плагин по ID.

Обновление плагина
client.beta.organization.plugins.update(pluginID, params, options?): BetaPlugin
POST/v1/organizations/plugins/{plugin_id}

Изменяет, какая из сохранённых версий плагина, принадлежащего организации, предоставляется участникам, — например, чтобы откатиться к более ранней. Это закрепляет предоставляемую версию: последующие загрузки сохраняются, но больше не меняют предоставляемую версию, а закрепление в настоящее время нельзя отменить ни здесь, ни в claude.ai.

Список плагинов
client.beta.organization.plugins.list(params?, options?): PageCursor<BetaPlugin>
GET/v1/organizations/plugins

Возвращает список плагинов, созданных в организации, начиная с самых новых: как находящихся в собственных маркетплейсах плагинов организации, так и в личных маркетплейсах плагинов участников.

Удаление плагина
client.beta.organization.plugins.delete(pluginID, params?, options?): BetaDeletedPlugin
DELETE/v1/organizations/plugins/{plugin_id}

Безвозвратно удаляет плагин и все его версии — точно так же, как при удалении администратором в claude.ai. Плагин может принадлежать организации или участнику, в том числе участнику, который с тех пор покинул организацию.

БетаОрганизацияПлагиныВерсии

Создание версии плагина
client.beta.organization.plugins.versions.create(pluginID, params, options?): BetaPluginVersion
POST/v1/organizations/plugins/{plugin_id}/versions

Добавляет версию в плагин, принадлежащий организации, путём загрузки файлов новой версии; она становится версией, предоставляемой участникам, если только предоставляемая версия плагина не была закреплена.

Список версий плагина
client.beta.organization.plugins.versions.list(pluginID, params?, options?): PageCursor<BetaPluginVersion>
GET/v1/organizations/plugins/{plugin_id}/versions

Возвращает список версий плагина, начиная с самых новых.

Получение версии плагина
client.beta.organization.plugins.versions.retrieve(version, params, options?): BetaPluginVersion
GET/v1/organizations/plugins/{plugin_id}/versions/{version}

Получает одну версию плагина по её идентификатору или самую новую версию плагина.

Скачивание архива версии плагина
client.beta.organization.plugins.versions.download(version, params, options?): Response
GET/v1/organizations/plugins/{plugin_id}/versions/{version}/content

Скачивает архив .zip одной версии точно в том виде, в каком он хранится. Каждое скачивание плагина из личного маркетплейса плагинов участника записывается в ленту активности Compliance API.

БетаОрганизацияПлагиныПараметры установки

Список параметров установки плагина
client.beta.organization.plugins.installationSettings.list(pluginID, params?, options?): PageCursor<BetaPluginInstallationSetting>
GET/v1/organizations/plugins/{plugin_id}/installation_settings

Возвращает список параметров установки плагина, принадлежащего организации, которые определяют, для каких участников он предназначен, начиная с созданных последними.

Задание параметра установки плагина
client.beta.organization.plugins.installationSettings.set(target, params, options?): BetaPluginInstallationSetting
POST/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

Задаёт или изменяет параметр установки плагина, принадлежащего организации, для всей организации или для одной группы RBAC.

Удаление параметра установки плагина
client.beta.organization.plugins.installationSettings.remove(target, params, options?): BetaDeletedPluginInstallationSetting
DELETE/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

Удаляет собственный параметр установки плагина, принадлежащего организации, для всей организации или для одной группы RBAC.

БетаОрганизацияПлагиныОбщий доступ

Список предоставлений доступа к плагину
client.beta.organization.plugins.shares.list(pluginID, params?, options?): PageCursor<BetaPluginShare>
GET/v1/organizations/plugins/{plugin_id}/shares

Возвращает список предоставлений общего доступа, выданных владельцем плагина, принадлежащего участнику, — всем участникам организации, группе RBAC или одному участнику, — начиная с предоставленных последними.

БетаОрганизацияМаркетплейсы плагинов

Список маркетплейсов плагинов
client.beta.organization.pluginMarketplaces.list(params?, options?): PageCursor<BetaPluginMarketplace>
GET/v1/organizations/plugin_marketplaces

Возвращает список маркетплейсов плагинов, в которых находятся плагины, начиная с самых новых: собственных маркетплейсов организации и личных маркетплейсов её участников.

Получение маркетплейса плагинов
client.beta.organization.pluginMarketplaces.retrieve(marketplaceID, params?, options?): BetaPluginMarketplace
GET/v1/organizations/plugin_marketplaces/{marketplace_id}

Получает маркетплейс плагинов по идентификатору.

Обновление маркетплейса плагинов
client.beta.organization.pluginMarketplaces.update(marketplaceID, params, options?): BetaPluginMarketplace
POST/v1/organizations/plugin_marketplaces/{marketplace_id}

Задаёт параметр установки по умолчанию для одного из собственных маркетплейсов плагинов организации. Каждый плагин в нём, у которого нет собственного параметра, получает это значение по умолчанию в качестве параметра на уровне всей организации, включая плагины, добавленные позже.

Проверка репозитория маркетплейса плагинов
client.beta.organization.pluginMarketplaces.validateRepository(params, options?): BetaPluginMarketplaceValidationReport
POST/v1/organizations/plugin_marketplaces/validate_repository

Проверяет, будет ли маркетплейс плагинов, размещённый в публичном репозитории GitHub, синхронизироваться в claude.ai, не подключая и не сохраняя его.

Проверка архива маркетплейса плагинов
client.beta.organization.pluginMarketplaces.validateArchive(params, options?): BetaPluginMarketplaceValidationReport
POST/v1/organizations/plugin_marketplaces/validate_archive

Проверяет, будет ли маркетплейс плагинов, загруженный в виде архива .zip каталога маркетплейса, синхронизироваться в claude.ai, не подключая и не сохраняя его.