Claude Platform Docs

Beta

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"

BetaModelos

Listar modelos
$ ant beta:models list
GET/v1/models
Obter um modelo
$ ant beta:models retrieve
GET/v1/models/{model_id}

BetaMensagens

Criar uma mensagem
$ ant beta:messages create
POST/v1/messages
Contar tokens em uma mensagem
$ ant beta:messages count-tokens
POST/v1/messages/count_tokens

BetaMensagensLotes

Criar um lote de mensagens
$ ant beta:messages:batches create
POST/v1/messages/batches
Recuperar um lote de mensagens
$ ant beta:messages:batches retrieve
GET/v1/messages/batches/{message_batch_id}
Listar lotes de mensagens
$ ant beta:messages:batches list
GET/v1/messages/batches
Cancelar um lote de mensagens
$ ant beta:messages:batches cancel
POST/v1/messages/batches/{message_batch_id}/cancel
Excluir um lote de mensagens
$ ant beta:messages:batches delete
DELETE/v1/messages/batches/{message_batch_id}
Recuperar resultados de um lote de mensagens
$ ant beta:messages:batches results
GET/v1/messages/batches/{message_batch_id}/results

BetaAgentes

Criar agente
$ ant beta:agents create
POST/v1/agents
Listar agentes
$ ant beta:agents list
GET/v1/agents
Obter agente
$ ant beta:agents retrieve
GET/v1/agents/{agent_id}
Atualizar agente
$ ant beta:agents update
POST/v1/agents/{agent_id}
Arquivar agente
$ ant beta:agents archive
POST/v1/agents/{agent_id}/archive

BetaAgentesVersões

Listar versões do agente
$ ant beta:agents:versions list
GET/v1/agents/{agent_id}/versions

BetaAmbientes

Criar ambiente
$ ant beta:environments create
POST/v1/environments
Listar ambientes
$ ant beta:environments list
GET/v1/environments
Obter ambiente
$ ant beta:environments retrieve
GET/v1/environments/{environment_id}
Atualizar ambiente
$ ant beta:environments update
POST/v1/environments/{environment_id}
Excluir ambiente
$ ant beta:environments delete
DELETE/v1/environments/{environment_id}
Arquivar ambiente
$ ant beta:environments archive
POST/v1/environments/{environment_id}/archive

BetaAmbientesTrabalho

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

BetaSessões

Criar sessão
$ ant beta:sessions create
POST/v1/sessions
Listar sessões
$ ant beta:sessions list
GET/v1/sessions
Obter sessão
$ ant beta:sessions retrieve
GET/v1/sessions/{session_id}
Atualizar sessão
$ ant beta:sessions update
POST/v1/sessions/{session_id}
Excluir sessão
$ ant beta:sessions delete
DELETE/v1/sessions/{session_id}
Arquivar sessão
$ ant beta:sessions archive
POST/v1/sessions/{session_id}/archive

BetaSessõesEventos

Listar eventos
$ ant beta:sessions:events list
GET/v1/sessions/{session_id}/events
Enviar eventos
$ ant beta:sessions:events send
POST/v1/sessions/{session_id}/events
Fazer streaming de eventos
$ ant beta:sessions:events stream
GET/v1/sessions/{session_id}/events/stream

BetaSessõesRecursos

Adicionar recurso de sessão
$ ant beta:sessions:resources add
POST/v1/sessions/{session_id}/resources
Listar recursos de sessão
$ ant beta:sessions:resources list
GET/v1/sessions/{session_id}/resources
Obter recurso de sessão
$ ant beta:sessions:resources retrieve
GET/v1/sessions/{session_id}/resources/{resource_id}
Atualizar recurso de sessão
$ ant beta:sessions:resources update
POST/v1/sessions/{session_id}/resources/{resource_id}
Excluir recurso de sessão
$ ant beta:sessions:resources delete
DELETE/v1/sessions/{session_id}/resources/{resource_id}

BetaSessõesThreads

Listar threads de sessão
$ ant beta:sessions:threads list
GET/v1/sessions/{session_id}/threads
Obter thread de sessão
$ ant beta:sessions:threads retrieve
GET/v1/sessions/{session_id}/threads/{thread_id}
Arquivar thread de sessão
$ ant beta:sessions:threads archive
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

BetaSessõesThreadsEventos

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

BetaImplantações

Criar implantação
$ ant beta:deployments create
POST/v1/deployments
Listar implantações
$ ant beta:deployments list
GET/v1/deployments
Obter implantação
$ ant beta:deployments retrieve
GET/v1/deployments/{deployment_id}
Atualizar implantação
$ ant beta:deployments update
POST/v1/deployments/{deployment_id}
Arquivar implantação
$ ant beta:deployments archive
POST/v1/deployments/{deployment_id}/archive
Executar implantação agora
$ ant beta:deployments run
POST/v1/deployments/{deployment_id}/run
Pausar implantação
$ ant beta:deployments pause
POST/v1/deployments/{deployment_id}/pause
Retomar implantação
$ ant beta:deployments unpause
POST/v1/deployments/{deployment_id}/unpause

BetaExecuções de implantação

Listar execuções de implantação
$ ant beta:deployment-runs list
GET/v1/deployment_runs
Obter execução de implantação
$ ant beta:deployment-runs retrieve
GET/v1/deployment_runs/{deployment_run_id}

BetaCofres

Criar cofre
$ ant beta:vaults create
POST/v1/vaults
Listar cofres
$ ant beta:vaults list
GET/v1/vaults
Obter cofre
$ ant beta:vaults retrieve
GET/v1/vaults/{vault_id}
Atualizar cofre
$ ant beta:vaults update
POST/v1/vaults/{vault_id}
Excluir cofre
$ ant beta:vaults delete
DELETE/v1/vaults/{vault_id}
Arquivar cofre
$ ant beta:vaults archive
POST/v1/vaults/{vault_id}/archive

BetaCofresCredenciais

Criar credencial
$ ant beta:vaults:credentials create
POST/v1/vaults/{vault_id}/credentials
Listar credenciais
$ ant beta:vaults:credentials list
GET/v1/vaults/{vault_id}/credentials
Obter credencial
$ ant beta:vaults:credentials retrieve
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Atualizar credencial
$ ant beta:vaults:credentials update
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Excluir credencial
$ ant beta:vaults:credentials delete
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Arquivar credencial
$ ant beta:vaults:credentials archive
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Validar credencial
$ ant beta:vaults:credentials mcp-oauth-validate
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate

BetaArmazenamentos de memória

Criar um armazenamento de memória
$ ant beta:memory-stores create
POST/v1/memory_stores
Listar armazenamentos de memória
$ ant beta:memory-stores list
GET/v1/memory_stores
Recuperar um armazenamento de memória
$ ant beta:memory-stores retrieve
GET/v1/memory_stores/{memory_store_id}
Atualizar um armazenamento de memória
$ ant beta:memory-stores update
POST/v1/memory_stores/{memory_store_id}
Excluir um armazenamento de memória
$ ant beta:memory-stores delete
DELETE/v1/memory_stores/{memory_store_id}
Arquivar um armazenamento de memória
$ ant beta:memory-stores archive
POST/v1/memory_stores/{memory_store_id}/archive

BetaArmazenamentos de memóriaMemórias

Criar uma memória
$ ant beta:memory-stores:memories create
POST/v1/memory_stores/{memory_store_id}/memories
Listar memórias
$ ant beta:memory-stores:memories list
GET/v1/memory_stores/{memory_store_id}/memories
Recuperar uma memória
$ ant beta:memory-stores:memories retrieve
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Atualizar uma memória
$ ant beta:memory-stores:memories update
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Excluir uma memória
$ ant beta:memory-stores:memories delete
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}

BetaArmazenamentos de memóriaVersões de memória

Listar versões de memória
$ ant beta:memory-stores:memory-versions list
GET/v1/memory_stores/{memory_store_id}/memory_versions
Recuperar uma versão de memória
$ ant beta:memory-stores:memory-versions retrieve
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
Suprimir uma versão de memória
$ ant beta:memory-stores:memory-versions redact
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

BetaArquivos

Fazer upload de arquivo
$ ant beta:files upload
POST/v1/files
Listar arquivos
$ ant beta:files list
GET/v1/files
Baixar arquivo
$ ant beta:files download
GET/v1/files/{file_id}/content
Obter metadados do arquivo
$ ant beta:files retrieve-metadata
GET/v1/files/{file_id}
Excluir arquivo
$ ant beta:files delete
DELETE/v1/files/{file_id}

BetaSkills

Criar skill
$ ant beta:skills create
POST/v1/skills
Listar skills
$ ant beta:skills list
GET/v1/skills
Obter skill
$ ant beta:skills retrieve
GET/v1/skills/{skill_id}
Excluir skill
$ ant beta:skills delete
DELETE/v1/skills/{skill_id}

BetaSkillsVersões

Criar versão de skill
$ ant beta:skills:versions create
POST/v1/skills/{skill_id}/versions
Listar versões de skill
$ ant beta:skills:versions list
GET/v1/skills/{skill_id}/versions
Baixar conteúdo de versão de skill
$ ant beta:skills:versions download
GET/v1/skills/{skill_id}/versions/{version}/content
Obter versão de skill
$ ant beta:skills:versions retrieve
GET/v1/skills/{skill_id}/versions/{version}
Excluir versão de skill
$ ant beta:skills:versions delete
DELETE/v1/skills/{skill_id}/versions/{version}

BetaPerfis de usuário

Criar perfil de usuário
$ ant beta:user-profiles create
POST/v1/user_profiles
Listar perfis de usuário
$ ant beta:user-profiles list
GET/v1/user_profiles
Obter perfil de usuário
$ ant beta:user-profiles retrieve
GET/v1/user_profiles/{user_profile_id}
Atualizar perfil de usuário
$ ant beta:user-profiles update
POST/v1/user_profiles/{user_profile_id}
Criar URL de inscrição
$ ant beta:user-profiles create-enrollment-url
POST/v1/user_profiles/{user_profile_id}/enrollment_url

BetaDreams

Criar um Dream
$ ant beta:dreams create
POST/v1/dreams
Listar Dreams
$ ant beta:dreams list
GET/v1/dreams
Obter um Dream
$ ant beta:dreams retrieve
GET/v1/dreams/{dream_id}
Cancelar um Dream
$ ant beta:dreams cancel
POST/v1/dreams/{dream_id}/cancel
Arquivar um Dream
$ ant beta:dreams archive
POST/v1/dreams/{dream_id}/archive

BetaTúneis

Criar túnel
$ ant beta:tunnels create
POST/v1/tunnels
Obter túnel
$ ant beta:tunnels retrieve
GET/v1/tunnels/{tunnel_id}
Listar túneis
$ ant beta:tunnels list
GET/v1/tunnels
Arquivar túnel
$ ant beta:tunnels archive
POST/v1/tunnels/{tunnel_id}/archive
Revelar token do túnel
$ ant beta:tunnels reveal-token
POST/v1/tunnels/{tunnel_id}/reveal_token
Rotacionar token do túnel
$ ant beta:tunnels rotate-token
POST/v1/tunnels/{tunnel_id}/rotate_token

BetaTúneisCertificados

Criar certificado de túnel
$ ant beta:tunnels:certificates create
POST/v1/tunnels/{tunnel_id}/certificates
Obter certificado de túnel
$ ant beta:tunnels:certificates retrieve
GET/v1/tunnels/{tunnel_id}/certificates/{certificate_id}
Listar certificados de túnel
$ ant beta:tunnels:certificates list
GET/v1/tunnels/{tunnel_id}/certificates
Arquivar certificado de túnel
$ ant beta:tunnels:certificates archive
POST/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

BetaOrganização

Obter organização atual
$ ant beta:organization retrieve
GET/v1/organizations/me

BetaOrganizaçãoChaves de API

Listar chaves de API
$ ant beta:organization:api-keys list
GET/v1/organizations/api_keys
Obter Chave de API
$ ant beta:organization:api-keys retrieve
GET/v1/organizations/api_keys/{api_key_id}
Atualizar chave de API
$ ant beta:organization:api-keys update
POST/v1/organizations/api_keys/{api_key_id}

BetaOrganizaçãoChaves externas

Criar chave externa
$ ant beta:organization:external-keys create
POST/v1/organizations/external_keys
Listar chaves externas
$ ant beta:organization:external-keys list
GET/v1/organizations/external_keys
Obter chave externa
$ ant beta:organization:external-keys retrieve
GET/v1/organizations/external_keys/{external_key_id}
Atualizar chave externa
$ ant beta:organization:external-keys update
POST/v1/organizations/external_keys/{external_key_id}
Excluir chave externa
$ ant beta:organization:external-keys delete
DELETE/v1/organizations/external_keys/{external_key_id}
Validar chave externa
$ ant beta:organization:external-keys validate
POST/v1/organizations/external_keys/{external_key_id}/validate

BetaOrganizaçãoFederaçãoEmissores

Criar emissor de federação
$ ant beta:organization:federation:issuers create
POST/v1/organizations/federation_issuers
Listar emissores de federação
$ ant beta:organization:federation:issuers list
GET/v1/organizations/federation_issuers
Obter emissor de federação
$ ant beta:organization:federation:issuers retrieve
GET/v1/organizations/federation_issuers/{federation_issuer_id}
Atualizar emissor de federação
$ ant beta:organization:federation:issuers update
POST/v1/organizations/federation_issuers/{federation_issuer_id}
Arquivar emissor de federação
$ ant beta:organization:federation:issuers archive
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

BetaOrganizaçãoFederaçãoRegras

Criar regra de federação
$ ant beta:organization:federation:rules create
POST/v1/organizations/federation_rules
Listar regras de federação
$ ant beta:organization:federation:rules list
GET/v1/organizations/federation_rules
Obter regra de federação
$ ant beta:organization:federation:rules retrieve
GET/v1/organizations/federation_rules/{federation_rule_id}
Atualizar regra de federação
$ ant beta:organization:federation:rules update
POST/v1/organizations/federation_rules/{federation_rule_id}
Arquivar regra de federação
$ ant beta:organization:federation:rules archive
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

BetaOrganizaçãoFederaçãoRegrasWorkspaces

Adicionar workspace à regra de federação
$ ant beta:organization:federation:rules:workspaces add
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Listar workspaces da regra de federação
$ ant beta:organization:federation:rules:workspaces list
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Remover workspace da regra de federação
$ ant beta:organization:federation:rules:workspaces remove
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

BetaOrganizaçãoConvites

Criar convite
$ ant beta:organization:invites create
POST/v1/organizations/invites
Listar convites
$ ant beta:organization:invites list
GET/v1/organizations/invites
Obter convite
$ ant beta:organization:invites retrieve
GET/v1/organizations/invites/{invite_id}
Excluir convite
$ ant beta:organization:invites delete
DELETE/v1/organizations/invites/{invite_id}

BetaOrganizaçãoContas de serviço

Criar conta de serviço
$ ant beta:organization:service-accounts create
POST/v1/organizations/service_accounts
Listar contas de serviço
$ ant beta:organization:service-accounts list
GET/v1/organizations/service_accounts
Obter conta de serviço
$ ant beta:organization:service-accounts retrieve
GET/v1/organizations/service_accounts/{service_account_id}
Atualizar conta de serviço
$ ant beta:organization:service-accounts update
POST/v1/organizations/service_accounts/{service_account_id}
Arquivar conta de serviço
$ ant beta:organization:service-accounts archive
POST/v1/organizations/service_accounts/{service_account_id}/archive

BetaOrganizaçãoContas de serviçoWorkspaces

Adicionar workspace à conta de serviço
$ ant beta:organization:service-accounts:workspaces add
POST/v1/organizations/service_accounts/{service_account_id}/workspaces
Listar workspaces da conta de serviço
$ ant beta:organization:service-accounts:workspaces list
GET/v1/organizations/service_accounts/{service_account_id}/workspaces
Remover workspace da conta de serviço
$ ant beta:organization:service-accounts:workspaces remove
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

BetaOrganizaçãoUsuários

Listar usuários
$ ant beta:organization:users list
GET/v1/organizations/users
Obter usuário
$ ant beta:organization:users retrieve
GET/v1/organizations/users/{user_id}
Atualizar usuário
$ ant beta:organization:users update
POST/v1/organizations/users/{user_id}
Remover usuário
$ ant beta:organization:users remove
DELETE/v1/organizations/users/{user_id}

BetaOrganizaçãoWorkspaces

Listar workspaces
$ ant beta:organization:workspaces list
GET/v1/organizations/workspaces
Criar workspace
$ ant beta:organization:workspaces create
POST/v1/organizations/workspaces
Obter workspace
$ ant beta:organization:workspaces retrieve
GET/v1/organizations/workspaces/{workspace_id}
Atualizar workspace
$ ant beta:organization:workspaces update
POST/v1/organizations/workspaces/{workspace_id}
Arquivar workspace
$ ant beta:organization:workspaces archive
POST/v1/organizations/workspaces/{workspace_id}/archive

BetaOrganizaçãoWorkspacesLimites de taxa

Listar limites de taxa do workspace
$ ant beta:organization:workspaces:rate-limits list
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

BetaOrganizaçãoWorkspacesMembros

Listar membros do workspace
$ ant beta:organization:workspaces:members list
GET/v1/organizations/workspaces/{workspace_id}/members
Criar membro do workspace
$ ant beta:organization:workspaces:members add
POST/v1/organizations/workspaces/{workspace_id}/members
Obter membro do workspace
$ ant beta:organization:workspaces:members retrieve
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Atualizar membro do workspace
$ ant beta:organization:workspaces:members update
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Excluir membro do workspace
$ ant beta:organization:workspaces:members remove
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

BetaOrganizaçãoWorkspacesContas de serviço

Listar membros de conta de serviço do workspace
$ ant beta:organization:workspaces:service-accounts list
GET/v1/organizations/workspaces/{workspace_id}/service_accounts
Criar membro de conta de serviço do workspace
$ ant beta:organization:workspaces:service-accounts add
POST/v1/organizations/workspaces/{workspace_id}/service_accounts
Obter membro de conta de serviço do workspace
$ ant beta:organization:workspaces:service-accounts retrieve
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Atualizar membro de conta de serviço do workspace
$ ant beta:organization:workspaces:service-accounts update
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Excluir membro de conta de serviço do workspace
$ ant beta:organization:workspaces:service-accounts remove
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

BetaOrganizaçãoLimites de taxa

Listar limites de taxa da organização
$ ant beta:organization:rate-limits list
GET/v1/organizations/rate_limits

BetaOrganizaçãoConfigurações de conformidade

Obter configurações de conformidade
$ ant beta:organization:compliance-settings retrieve
GET/v1/organizations/compliance_settings
Atualizar configurações de conformidade
$ ant beta:organization:compliance-settings update
POST/v1/organizations/compliance_settings