Claude Platform Docs

Beta

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

BetaModelos

Listar modelos
GET/v1/models
Obter um modelo
GET/v1/models/{model_id}

BetaMensagens

Criar uma mensagem
POST/v1/messages
Contar tokens em uma mensagem
POST/v1/messages/count_tokens

BetaMensagensLotes

Criar um lote de mensagens
POST/v1/messages/batches
Recuperar um lote de mensagens
GET/v1/messages/batches/{message_batch_id}
Listar lotes de mensagens
GET/v1/messages/batches
Cancelar um lote de mensagens
POST/v1/messages/batches/{message_batch_id}/cancel
Excluir um lote de mensagens
DELETE/v1/messages/batches/{message_batch_id}
Recuperar resultados de um lote de mensagens
GET/v1/messages/batches/{message_batch_id}/results

BetaAgentes

Criar agente
POST/v1/agents
Listar agentes
GET/v1/agents
Obter agente
GET/v1/agents/{agent_id}
Atualizar agente
POST/v1/agents/{agent_id}
Arquivar agente
POST/v1/agents/{agent_id}/archive

BetaAgentesVersões

Listar versões do agente
GET/v1/agents/{agent_id}/versions

BetaAmbientes

Criar ambiente
POST/v1/environments
Listar ambientes
GET/v1/environments
Obter ambiente
GET/v1/environments/{environment_id}
Atualizar ambiente
POST/v1/environments/{environment_id}
Excluir ambiente
DELETE/v1/environments/{environment_id}
Arquivar ambiente
POST/v1/environments/{environment_id}/archive

BetaAmbientesTrabalho

Obter item de trabalho
GET/v1/environments/{environment_id}/work/{work_id}
Fazer polling por trabalho
GET/v1/environments/{environment_id}/work/poll
Confirmar recebimento de trabalho
POST/v1/environments/{environment_id}/work/{work_id}/ack
Registrar heartbeat
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat
Parar trabalho
POST/v1/environments/{environment_id}/work/{work_id}/stop
Listar itens de trabalho
GET/v1/environments/{environment_id}/work
Atualizar item de trabalho
POST/v1/environments/{environment_id}/work/{work_id}
Obter estatísticas da fila
GET/v1/environments/{environment_id}/work/stats

BetaSessões

Criar sessão
POST/v1/sessions
Listar sessões
GET/v1/sessions
Obter sessão
GET/v1/sessions/{session_id}
Atualizar sessão
POST/v1/sessions/{session_id}
Excluir sessão
DELETE/v1/sessions/{session_id}
Arquivar sessão
POST/v1/sessions/{session_id}/archive

BetaSessõesEventos

Listar eventos
GET/v1/sessions/{session_id}/events
Enviar eventos
POST/v1/sessions/{session_id}/events
Fazer streaming de eventos
GET/v1/sessions/{session_id}/events/stream

BetaSessõesRecursos

Adicionar recurso de sessão
POST/v1/sessions/{session_id}/resources
Listar recursos de sessão
GET/v1/sessions/{session_id}/resources
Obter recurso de sessão
GET/v1/sessions/{session_id}/resources/{resource_id}
Atualizar recurso de sessão
POST/v1/sessions/{session_id}/resources/{resource_id}
Excluir recurso de sessão
DELETE/v1/sessions/{session_id}/resources/{resource_id}

BetaSessõesThreads

Listar threads de sessão
GET/v1/sessions/{session_id}/threads
Obter thread de sessão
GET/v1/sessions/{session_id}/threads/{thread_id}
Arquivar thread de sessão
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

BetaSessõesThreadsEventos

Listar eventos de thread de sessão
GET/v1/sessions/{session_id}/threads/{thread_id}/events
Fazer streaming de eventos de thread de sessão
GET/v1/sessions/{session_id}/threads/{thread_id}/stream

BetaImplantações

Criar implantação
POST/v1/deployments
Listar implantações
GET/v1/deployments
Obter implantação
GET/v1/deployments/{deployment_id}
Atualizar implantação
POST/v1/deployments/{deployment_id}
Arquivar implantação
POST/v1/deployments/{deployment_id}/archive
Executar implantação agora
POST/v1/deployments/{deployment_id}/run
Pausar implantação
POST/v1/deployments/{deployment_id}/pause
Retomar implantação
POST/v1/deployments/{deployment_id}/unpause

BetaExecuções de implantação

Listar execuções de implantação
GET/v1/deployment_runs
Obter execução de implantação
GET/v1/deployment_runs/{deployment_run_id}

BetaCofres

Criar cofre
POST/v1/vaults
Listar cofres
GET/v1/vaults
Obter cofre
GET/v1/vaults/{vault_id}
Atualizar cofre
POST/v1/vaults/{vault_id}
Excluir cofre
DELETE/v1/vaults/{vault_id}
Arquivar cofre
POST/v1/vaults/{vault_id}/archive

BetaCofresCredenciais

Criar credencial
POST/v1/vaults/{vault_id}/credentials
Listar credenciais
GET/v1/vaults/{vault_id}/credentials
Obter credencial
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Atualizar credencial
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Excluir credencial
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Arquivar credencial
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Validar credencial
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate

BetaArmazenamentos de memória

Criar um armazenamento de memória
POST/v1/memory_stores
Listar armazenamentos de memória
GET/v1/memory_stores
Recuperar um armazenamento de memória
GET/v1/memory_stores/{memory_store_id}
Atualizar um armazenamento de memória
POST/v1/memory_stores/{memory_store_id}
Excluir um armazenamento de memória
DELETE/v1/memory_stores/{memory_store_id}
Arquivar um armazenamento de memória
POST/v1/memory_stores/{memory_store_id}/archive

BetaArmazenamentos de memóriaMemórias

Criar uma memória
POST/v1/memory_stores/{memory_store_id}/memories
Listar memórias
GET/v1/memory_stores/{memory_store_id}/memories
Recuperar uma memória
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Atualizar uma memória
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Excluir uma memória
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}

BetaArmazenamentos de memóriaVersões de memória

Listar versões de memória
GET/v1/memory_stores/{memory_store_id}/memory_versions
Recuperar uma versão de memória
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
Suprimir uma versão de memória
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

BetaArquivos

Fazer upload de arquivo
POST/v1/files
Listar arquivos
GET/v1/files
Baixar arquivo
GET/v1/files/{file_id}/content
Obter metadados do arquivo
GET/v1/files/{file_id}
Excluir arquivo
DELETE/v1/files/{file_id}

BetaSkills

Criar skill
POST/v1/skills
Listar skills
GET/v1/skills
Obter skill
GET/v1/skills/{skill_id}
Excluir skill
DELETE/v1/skills/{skill_id}

BetaSkillsVersões

Criar versão de skill
POST/v1/skills/{skill_id}/versions
Listar versões de skill
GET/v1/skills/{skill_id}/versions
Baixar conteúdo de versão de skill
GET/v1/skills/{skill_id}/versions/{version}/content
Obter versão de skill
GET/v1/skills/{skill_id}/versions/{version}
Excluir versão de skill
DELETE/v1/skills/{skill_id}/versions/{version}

BetaWebhooks

Unwrap
Function
Parse Unverified
Function

BetaPerfis de usuário

Criar perfil de usuário
POST/v1/user_profiles
Listar perfis de usuário
GET/v1/user_profiles
Obter perfil de usuário
GET/v1/user_profiles/{user_profile_id}
Atualizar perfil de usuário
POST/v1/user_profiles/{user_profile_id}
Criar URL de inscrição
POST/v1/user_profiles/{user_profile_id}/enrollment_url

BetaDreams

Criar um Dream
POST/v1/dreams
Listar Dreams
GET/v1/dreams
Obter um Dream
GET/v1/dreams/{dream_id}
Cancelar um Dream
POST/v1/dreams/{dream_id}/cancel
Arquivar um Dream
POST/v1/dreams/{dream_id}/archive

BetaTúneis

Criar túnel
POST/v1/tunnels
Obter túnel
GET/v1/tunnels/{tunnel_id}
Listar túneis
GET/v1/tunnels
Arquivar túnel
POST/v1/tunnels/{tunnel_id}/archive
Revelar token do túnel
POST/v1/tunnels/{tunnel_id}/reveal_token
Rotacionar token do túnel
POST/v1/tunnels/{tunnel_id}/rotate_token

BetaTúneisCertificados

Criar certificado de túnel
POST/v1/tunnels/{tunnel_id}/certificates
Obter certificado de túnel
GET/v1/tunnels/{tunnel_id}/certificates/{certificate_id}
Listar certificados de túnel
GET/v1/tunnels/{tunnel_id}/certificates
Arquivar certificado de túnel
POST/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

BetaOrganização

Obter organização atual
GET/v1/organizations/me

BetaOrganizaçãoChaves de API

Listar chaves de API
GET/v1/organizations/api_keys
Obter Chave de API
GET/v1/organizations/api_keys/{api_key_id}
Atualizar chave de API
POST/v1/organizations/api_keys/{api_key_id}

BetaOrganizaçãoChaves externas

Criar chave externa
POST/v1/organizations/external_keys
Listar chaves externas
GET/v1/organizations/external_keys
Obter chave externa
GET/v1/organizations/external_keys/{external_key_id}
Atualizar chave externa
POST/v1/organizations/external_keys/{external_key_id}
Excluir chave externa
DELETE/v1/organizations/external_keys/{external_key_id}
Validar chave externa
POST/v1/organizations/external_keys/{external_key_id}/validate

BetaOrganizaçãoFederaçãoEmissores

Criar emissor de federação
POST/v1/organizations/federation_issuers
Listar emissores de federação
GET/v1/organizations/federation_issuers
Obter emissor de federação
GET/v1/organizations/federation_issuers/{federation_issuer_id}
Atualizar emissor de federação
POST/v1/organizations/federation_issuers/{federation_issuer_id}
Arquivar emissor de federação
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

BetaOrganizaçãoFederaçãoRegras

Criar regra de federação
POST/v1/organizations/federation_rules
Listar regras de federação
GET/v1/organizations/federation_rules
Obter regra de federação
GET/v1/organizations/federation_rules/{federation_rule_id}
Atualizar regra de federação
POST/v1/organizations/federation_rules/{federation_rule_id}
Arquivar regra de federação
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

BetaOrganizaçãoFederaçãoRegrasWorkspaces

Adicionar workspace à regra de federação
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Listar workspaces da regra de federação
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Remover workspace da regra de federação
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

BetaOrganizaçãoConvites

Criar convite
POST/v1/organizations/invites
Listar convites
GET/v1/organizations/invites
Obter convite
GET/v1/organizations/invites/{invite_id}
Excluir convite
DELETE/v1/organizations/invites/{invite_id}

BetaOrganizaçãoContas de serviço

Criar conta de serviço
POST/v1/organizations/service_accounts
Listar contas de serviço
GET/v1/organizations/service_accounts
Obter conta de serviço
GET/v1/organizations/service_accounts/{service_account_id}
Atualizar conta de serviço
POST/v1/organizations/service_accounts/{service_account_id}
Arquivar conta de serviço
POST/v1/organizations/service_accounts/{service_account_id}/archive

BetaOrganizaçãoContas de serviçoWorkspaces

Adicionar workspace à conta de serviço
POST/v1/organizations/service_accounts/{service_account_id}/workspaces
Listar workspaces da conta de serviço
GET/v1/organizations/service_accounts/{service_account_id}/workspaces
Remover workspace da conta de serviço
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

BetaOrganizaçãoUsuários

Listar usuários
GET/v1/organizations/users
Obter usuário
GET/v1/organizations/users/{user_id}
Atualizar usuário
POST/v1/organizations/users/{user_id}
Remover usuário
DELETE/v1/organizations/users/{user_id}

BetaOrganizaçãoWorkspaces

Listar workspaces
GET/v1/organizations/workspaces
Criar workspace
POST/v1/organizations/workspaces
Obter workspace
GET/v1/organizations/workspaces/{workspace_id}
Atualizar workspace
POST/v1/organizations/workspaces/{workspace_id}
Arquivar workspace
POST/v1/organizations/workspaces/{workspace_id}/archive

BetaOrganizaçãoWorkspacesLimites de taxa

Listar limites de taxa do workspace
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

BetaOrganizaçãoWorkspacesMembros

Listar membros do workspace
GET/v1/organizations/workspaces/{workspace_id}/members
Criar membro do workspace
POST/v1/organizations/workspaces/{workspace_id}/members
Obter membro do workspace
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Atualizar membro do workspace
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Excluir membro do workspace
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

BetaOrganizaçãoWorkspacesContas de serviço

Listar membros de conta de serviço do workspace
GET/v1/organizations/workspaces/{workspace_id}/service_accounts
Criar membro de conta de serviço do workspace
POST/v1/organizations/workspaces/{workspace_id}/service_accounts
Obter membro de conta de serviço do workspace
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Atualizar membro de conta de serviço do workspace
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Excluir membro de conta de serviço do workspace
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

BetaOrganizaçãoLimites de taxa

Listar limites de taxa da organização
GET/v1/organizations/rate_limits

BetaOrganizaçãoConfigurações de conformidade

Obter configurações de conformidade
GET/v1/organizations/compliance_settings
Atualizar configurações de conformidade
POST/v1/organizations/compliance_settings