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"

BetaModelli

Elenca i modelli
$ ant beta:models list
GET/v1/models
Ottieni un modello
$ ant beta:models retrieve
GET/v1/models/{model_id}

BetaMessaggi

Crea un messaggio
$ ant beta:messages create
POST/v1/messages
Conta i token in un messaggio
$ ant beta:messages count-tokens
POST/v1/messages/count_tokens

BetaMessaggiBatch

Crea un batch di messaggi
$ ant beta:messages:batches create
POST/v1/messages/batches
Recupera un batch di messaggi
$ ant beta:messages:batches retrieve
GET/v1/messages/batches/{message_batch_id}
Elenca i batch di messaggi
$ ant beta:messages:batches list
GET/v1/messages/batches
Annulla un batch di messaggi
$ ant beta:messages:batches cancel
POST/v1/messages/batches/{message_batch_id}/cancel
Elimina un batch di messaggi
$ ant beta:messages:batches delete
DELETE/v1/messages/batches/{message_batch_id}
Recupera i risultati di un batch di messaggi
$ ant beta:messages:batches results
GET/v1/messages/batches/{message_batch_id}/results

BetaAgenti

Crea agente
$ ant beta:agents create
POST/v1/agents
Elenca gli agenti
$ ant beta:agents list
GET/v1/agents
Ottieni agente
$ ant beta:agents retrieve
GET/v1/agents/{agent_id}
Aggiorna agente
$ ant beta:agents update
POST/v1/agents/{agent_id}
Archivia agente
$ ant beta:agents archive
POST/v1/agents/{agent_id}/archive

BetaAgentiVersioni

Elenca le versioni dell'agente
$ ant beta:agents:versions list
GET/v1/agents/{agent_id}/versions

BetaAmbienti

Crea ambiente
$ ant beta:environments create
POST/v1/environments
Elenca gli ambienti
$ ant beta:environments list
GET/v1/environments
Ottieni ambiente
$ ant beta:environments retrieve
GET/v1/environments/{environment_id}
Aggiorna ambiente
$ ant beta:environments update
POST/v1/environments/{environment_id}
Elimina ambiente
$ ant beta:environments delete
DELETE/v1/environments/{environment_id}
Archivia ambiente
$ ant beta:environments archive
POST/v1/environments/{environment_id}/archive

BetaAmbientiLavoro

Ottieni elemento di lavoro
$ ant beta:environments:work retrieve
GET/v1/environments/{environment_id}/work/{work_id}
Esegui polling del lavoro
$ ant beta:environments:work poll
GET/v1/environments/{environment_id}/work/poll
Conferma ricezione del lavoro
$ ant beta:environments:work ack
POST/v1/environments/{environment_id}/work/{work_id}/ack
Registra heartbeat
$ ant beta:environments:work heartbeat
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat
Arresta lavoro
$ ant beta:environments:work stop
POST/v1/environments/{environment_id}/work/{work_id}/stop
Elenca gli elementi di lavoro
$ ant beta:environments:work list
GET/v1/environments/{environment_id}/work
Aggiorna elemento di lavoro
$ ant beta:environments:work update
POST/v1/environments/{environment_id}/work/{work_id}
Ottieni statistiche della coda
$ ant beta:environments:work stats
GET/v1/environments/{environment_id}/work/stats

BetaSessioni

Crea sessione
$ ant beta:sessions create
POST/v1/sessions
Elenca le sessioni
$ ant beta:sessions list
GET/v1/sessions
Ottieni sessione
$ ant beta:sessions retrieve
GET/v1/sessions/{session_id}
Aggiorna sessione
$ ant beta:sessions update
POST/v1/sessions/{session_id}
Elimina sessione
$ ant beta:sessions delete
DELETE/v1/sessions/{session_id}
Archivia sessione
$ ant beta:sessions archive
POST/v1/sessions/{session_id}/archive

BetaSessioniEventi

Elenca gli eventi
$ ant beta:sessions:events list
GET/v1/sessions/{session_id}/events
Invia eventi
$ ant beta:sessions:events send
POST/v1/sessions/{session_id}/events
Trasmetti eventi in streaming
$ ant beta:sessions:events stream
GET/v1/sessions/{session_id}/events/stream

BetaSessioniRisorse

Aggiungi risorsa di sessione
$ ant beta:sessions:resources add
POST/v1/sessions/{session_id}/resources
Elenca le risorse di sessione
$ ant beta:sessions:resources list
GET/v1/sessions/{session_id}/resources
Ottieni risorsa di sessione
$ ant beta:sessions:resources retrieve
GET/v1/sessions/{session_id}/resources/{resource_id}
Aggiorna risorsa di sessione
$ ant beta:sessions:resources update
POST/v1/sessions/{session_id}/resources/{resource_id}
Elimina risorsa di sessione
$ ant beta:sessions:resources delete
DELETE/v1/sessions/{session_id}/resources/{resource_id}

BetaSessioniThread

Elenca i thread di sessione
$ ant beta:sessions:threads list
GET/v1/sessions/{session_id}/threads
Ottieni thread di sessione
$ ant beta:sessions:threads retrieve
GET/v1/sessions/{session_id}/threads/{thread_id}
Archivia thread di sessione
$ ant beta:sessions:threads archive
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

BetaSessioniThreadEventi

Elenca gli eventi del thread di sessione
$ ant beta:sessions:threads:events list
GET/v1/sessions/{session_id}/threads/{thread_id}/events
Trasmetti in streaming gli eventi del thread di sessione
$ ant beta:sessions:threads:events stream
GET/v1/sessions/{session_id}/threads/{thread_id}/stream

BetaDeployment

Crea deployment
$ ant beta:deployments create
POST/v1/deployments
Elenca i deployment
$ ant beta:deployments list
GET/v1/deployments
Ottieni deployment
$ ant beta:deployments retrieve
GET/v1/deployments/{deployment_id}
Aggiorna deployment
$ ant beta:deployments update
POST/v1/deployments/{deployment_id}
Archivia deployment
$ ant beta:deployments archive
POST/v1/deployments/{deployment_id}/archive
Esegui deployment ora
$ ant beta:deployments run
POST/v1/deployments/{deployment_id}/run
Sospendi deployment
$ ant beta:deployments pause
POST/v1/deployments/{deployment_id}/pause
Riprendi deployment
$ ant beta:deployments unpause
POST/v1/deployments/{deployment_id}/unpause

BetaEsecuzioni del deployment

Elenca esecuzioni del deployment
$ ant beta:deployment-runs list
GET/v1/deployment_runs
Ottieni esecuzione del deployment
$ ant beta:deployment-runs retrieve
GET/v1/deployment_runs/{deployment_run_id}

BetaVault

Crea vault
$ ant beta:vaults create
POST/v1/vaults
Elenca vault
$ ant beta:vaults list
GET/v1/vaults
Ottieni vault
$ ant beta:vaults retrieve
GET/v1/vaults/{vault_id}
Aggiorna vault
$ ant beta:vaults update
POST/v1/vaults/{vault_id}
Elimina vault
$ ant beta:vaults delete
DELETE/v1/vaults/{vault_id}
Archivia vault
$ ant beta:vaults archive
POST/v1/vaults/{vault_id}/archive

BetaVaultCredenziali

Crea credenziale
$ ant beta:vaults:credentials create
POST/v1/vaults/{vault_id}/credentials
Elenca credenziali
$ ant beta:vaults:credentials list
GET/v1/vaults/{vault_id}/credentials
Ottieni credenziale
$ ant beta:vaults:credentials retrieve
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Aggiorna credenziale
$ ant beta:vaults:credentials update
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Elimina credenziale
$ ant beta:vaults:credentials delete
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Archivia credenziale
$ ant beta:vaults:credentials archive
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Convalida credenziale
$ ant beta:vaults:credentials mcp-oauth-validate
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate

BetaArchivi di memoria

Crea un archivio di memoria
$ ant beta:memory-stores create
POST/v1/memory_stores
Elenca archivi di memoria
$ ant beta:memory-stores list
GET/v1/memory_stores
Recupera un archivio di memoria
$ ant beta:memory-stores retrieve
GET/v1/memory_stores/{memory_store_id}
Aggiorna un archivio di memoria
$ ant beta:memory-stores update
POST/v1/memory_stores/{memory_store_id}
Elimina un archivio di memoria
$ ant beta:memory-stores delete
DELETE/v1/memory_stores/{memory_store_id}
Archivia un archivio di memoria
$ ant beta:memory-stores archive
POST/v1/memory_stores/{memory_store_id}/archive

BetaArchivi di memoriaMemorie

Crea una memoria
$ ant beta:memory-stores:memories create
POST/v1/memory_stores/{memory_store_id}/memories
Elenca memorie
$ ant beta:memory-stores:memories list
GET/v1/memory_stores/{memory_store_id}/memories
Recupera una memoria
$ ant beta:memory-stores:memories retrieve
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Aggiorna una memoria
$ ant beta:memory-stores:memories update
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Elimina una memoria
$ ant beta:memory-stores:memories delete
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}

BetaArchivi di memoriaVersioni della memoria

Elenca versioni della memoria
$ ant beta:memory-stores:memory-versions list
GET/v1/memory_stores/{memory_store_id}/memory_versions
Recupera una versione della memoria
$ ant beta:memory-stores:memory-versions retrieve
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
Oscura una versione della memoria
$ ant beta:memory-stores:memory-versions redact
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

BetaFile

Carica file
$ ant beta:files upload
POST/v1/files
Elenca i file
$ ant beta:files list
GET/v1/files
Scarica file
$ ant beta:files download
GET/v1/files/{file_id}/content
Ottieni metadati del file
$ ant beta:files retrieve-metadata
GET/v1/files/{file_id}
Elimina file
$ ant beta:files delete
DELETE/v1/files/{file_id}

BetaSkill

Crea skill
$ ant beta:skills create
POST/v1/skills
Elenca le skill
$ ant beta:skills list
GET/v1/skills
Ottieni skill
$ ant beta:skills retrieve
GET/v1/skills/{skill_id}
Elimina skill
$ ant beta:skills delete
DELETE/v1/skills/{skill_id}

BetaSkillVersioni

Crea versione della skill
$ ant beta:skills:versions create
POST/v1/skills/{skill_id}/versions
Elenca le versioni della skill
$ ant beta:skills:versions list
GET/v1/skills/{skill_id}/versions
Scarica contenuto versione skill
$ ant beta:skills:versions download
GET/v1/skills/{skill_id}/versions/{version}/content
Ottieni versione della skill
$ ant beta:skills:versions retrieve
GET/v1/skills/{skill_id}/versions/{version}
Elimina versione della skill
$ ant beta:skills:versions delete
DELETE/v1/skills/{skill_id}/versions/{version}

BetaProfili utente

Crea profilo utente
$ ant beta:user-profiles create
POST/v1/user_profiles
Elenca profili utente
$ ant beta:user-profiles list
GET/v1/user_profiles
Ottieni profilo utente
$ ant beta:user-profiles retrieve
GET/v1/user_profiles/{user_profile_id}
Aggiorna profilo utente
$ ant beta:user-profiles update
POST/v1/user_profiles/{user_profile_id}
Crea URL di registrazione
$ ant beta:user-profiles create-enrollment-url
POST/v1/user_profiles/{user_profile_id}/enrollment_url

BetaDream

Crea un Dream
$ ant beta:dreams create
POST/v1/dreams
Elenca Dream
$ ant beta:dreams list
GET/v1/dreams
Ottieni un Dream
$ ant beta:dreams retrieve
GET/v1/dreams/{dream_id}
Annulla un Dream
$ ant beta:dreams cancel
POST/v1/dreams/{dream_id}/cancel
Archivia un Dream
$ ant beta:dreams archive
POST/v1/dreams/{dream_id}/archive

BetaTunnel

Crea tunnel
$ ant beta:tunnels create
POST/v1/tunnels
Ottieni tunnel
$ ant beta:tunnels retrieve
GET/v1/tunnels/{tunnel_id}
Elenca tunnel
$ ant beta:tunnels list
GET/v1/tunnels
Archivia tunnel
$ ant beta:tunnels archive
POST/v1/tunnels/{tunnel_id}/archive
Rivela token del tunnel
$ ant beta:tunnels reveal-token
POST/v1/tunnels/{tunnel_id}/reveal_token
Ruota token del tunnel
$ ant beta:tunnels rotate-token
POST/v1/tunnels/{tunnel_id}/rotate_token

BetaTunnelCertificati

Crea certificato del tunnel
$ ant beta:tunnels:certificates create
POST/v1/tunnels/{tunnel_id}/certificates
Ottieni certificato del tunnel
$ ant beta:tunnels:certificates retrieve
GET/v1/tunnels/{tunnel_id}/certificates/{certificate_id}
Elenca certificati del tunnel
$ ant beta:tunnels:certificates list
GET/v1/tunnels/{tunnel_id}/certificates
Archivia certificato del tunnel
$ ant beta:tunnels:certificates archive
POST/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

BetaOrganizzazione

Ottieni l'organizzazione corrente
$ ant beta:organization retrieve
GET/v1/organizations/me

BetaOrganizzazioneChiavi API

Elenca chiavi API
$ ant beta:organization:api-keys list
GET/v1/organizations/api_keys
Ottieni chiave API
$ ant beta:organization:api-keys retrieve
GET/v1/organizations/api_keys/{api_key_id}
Aggiorna chiave API
$ ant beta:organization:api-keys update
POST/v1/organizations/api_keys/{api_key_id}

BetaOrganizzazioneChiavi esterne

Crea chiave esterna
$ ant beta:organization:external-keys create
POST/v1/organizations/external_keys
Elenca chiavi esterne
$ ant beta:organization:external-keys list
GET/v1/organizations/external_keys
Ottieni chiave esterna
$ ant beta:organization:external-keys retrieve
GET/v1/organizations/external_keys/{external_key_id}
Aggiorna chiave esterna
$ ant beta:organization:external-keys update
POST/v1/organizations/external_keys/{external_key_id}
Elimina chiave esterna
$ ant beta:organization:external-keys delete
DELETE/v1/organizations/external_keys/{external_key_id}
Convalida chiave esterna
$ ant beta:organization:external-keys validate
POST/v1/organizations/external_keys/{external_key_id}/validate

BetaOrganizzazioneFederazioneEmittenti

Crea issuer di federazione
$ ant beta:organization:federation:issuers create
POST/v1/organizations/federation_issuers
Elenca issuer di federazione
$ ant beta:organization:federation:issuers list
GET/v1/organizations/federation_issuers
Ottieni issuer di federazione
$ ant beta:organization:federation:issuers retrieve
GET/v1/organizations/federation_issuers/{federation_issuer_id}
Aggiorna issuer di federazione
$ ant beta:organization:federation:issuers update
POST/v1/organizations/federation_issuers/{federation_issuer_id}
Archivia issuer di federazione
$ ant beta:organization:federation:issuers archive
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

BetaOrganizzazioneFederazioneRegole

Crea regola di federazione
$ ant beta:organization:federation:rules create
POST/v1/organizations/federation_rules
Elenca regole di federazione
$ ant beta:organization:federation:rules list
GET/v1/organizations/federation_rules
Ottieni regola di federazione
$ ant beta:organization:federation:rules retrieve
GET/v1/organizations/federation_rules/{federation_rule_id}
Aggiorna regola di federazione
$ ant beta:organization:federation:rules update
POST/v1/organizations/federation_rules/{federation_rule_id}
Archivia regola di federazione
$ ant beta:organization:federation:rules archive
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

BetaOrganizzazioneFederazioneRegoleWorkspace

Aggiungi workspace alla regola di federazione
$ ant beta:organization:federation:rules:workspaces add
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Elenca workspace della regola di federazione
$ ant beta:organization:federation:rules:workspaces list
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Rimuovi workspace dalla regola di federazione
$ ant beta:organization:federation:rules:workspaces remove
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

BetaOrganizzazioneInviti

Crea invito
$ ant beta:organization:invites create
POST/v1/organizations/invites
Elenca inviti
$ ant beta:organization:invites list
GET/v1/organizations/invites
Ottieni invito
$ ant beta:organization:invites retrieve
GET/v1/organizations/invites/{invite_id}
Elimina invito
$ ant beta:organization:invites delete
DELETE/v1/organizations/invites/{invite_id}

BetaOrganizzazioneService account

Crea service account
$ ant beta:organization:service-accounts create
POST/v1/organizations/service_accounts
Elenca service account
$ ant beta:organization:service-accounts list
GET/v1/organizations/service_accounts
Ottieni service account
$ ant beta:organization:service-accounts retrieve
GET/v1/organizations/service_accounts/{service_account_id}
Aggiorna service account
$ ant beta:organization:service-accounts update
POST/v1/organizations/service_accounts/{service_account_id}
Archivia service account
$ ant beta:organization:service-accounts archive
POST/v1/organizations/service_accounts/{service_account_id}/archive

BetaOrganizzazioneService accountWorkspace

Aggiungi workspace al service account
$ ant beta:organization:service-accounts:workspaces add
POST/v1/organizations/service_accounts/{service_account_id}/workspaces
Elenca workspace per il service account
$ ant beta:organization:service-accounts:workspaces list
GET/v1/organizations/service_accounts/{service_account_id}/workspaces
Rimuovi workspace dal service account
$ ant beta:organization:service-accounts:workspaces remove
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

BetaOrganizzazioneUtenti

Elenca utenti
$ ant beta:organization:users list
GET/v1/organizations/users
Ottieni utente
$ ant beta:organization:users retrieve
GET/v1/organizations/users/{user_id}
Aggiorna utente
$ ant beta:organization:users update
POST/v1/organizations/users/{user_id}
Rimuovi utente
$ ant beta:organization:users remove
DELETE/v1/organizations/users/{user_id}

BetaOrganizzazioneWorkspace

Elenca workspace
$ ant beta:organization:workspaces list
GET/v1/organizations/workspaces
Crea workspace
$ ant beta:organization:workspaces create
POST/v1/organizations/workspaces
Ottieni workspace
$ ant beta:organization:workspaces retrieve
GET/v1/organizations/workspaces/{workspace_id}
Aggiorna workspace
$ ant beta:organization:workspaces update
POST/v1/organizations/workspaces/{workspace_id}
Archivia workspace
$ ant beta:organization:workspaces archive
POST/v1/organizations/workspaces/{workspace_id}/archive

BetaOrganizzazioneWorkspaceLimiti di velocità

Elenca limiti di velocità del workspace
$ ant beta:organization:workspaces:rate-limits list
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

BetaOrganizzazioneWorkspaceMembri

Elenca membri del workspace
$ ant beta:organization:workspaces:members list
GET/v1/organizations/workspaces/{workspace_id}/members
Crea membro del workspace
$ ant beta:organization:workspaces:members add
POST/v1/organizations/workspaces/{workspace_id}/members
Ottieni membro del workspace
$ ant beta:organization:workspaces:members retrieve
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Aggiorna membro del workspace
$ ant beta:organization:workspaces:members update
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Elimina membro del workspace
$ ant beta:organization:workspaces:members remove
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

BetaOrganizzazioneWorkspaceService account

Elenca membri service account del workspace
$ ant beta:organization:workspaces:service-accounts list
GET/v1/organizations/workspaces/{workspace_id}/service_accounts
Crea membro service account del workspace
$ ant beta:organization:workspaces:service-accounts add
POST/v1/organizations/workspaces/{workspace_id}/service_accounts
Ottieni membro service account del workspace
$ ant beta:organization:workspaces:service-accounts retrieve
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Aggiorna membro service account del workspace
$ ant beta:organization:workspaces:service-accounts update
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Elimina membro service account del workspace
$ ant beta:organization:workspaces:service-accounts remove
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

BetaOrganizzazioneLimiti di velocità

Elenca limiti di velocità dell'organizzazione
$ ant beta:organization:rate-limits list
GET/v1/organizations/rate_limits

BetaOrganizzazioneImpostazioni di conformità

Ottieni impostazioni di conformità
$ ant beta:organization:compliance-settings retrieve
GET/v1/organizations/compliance_settings
Aggiorna impostazioni di conformità
$ ant beta:organization:compliance-settings update
POST/v1/organizations/compliance_settings