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

BetaModelli

Elenca i modelli
GET/v1/models
Ottieni un modello
GET/v1/models/{model_id}

BetaMessaggi

Crea un messaggio
POST/v1/messages
Conta i token in un messaggio
POST/v1/messages/count_tokens

BetaMessaggiBatch

Crea un batch di messaggi
POST/v1/messages/batches
Recupera un batch di messaggi
GET/v1/messages/batches/{message_batch_id}
Elenca i batch di messaggi
GET/v1/messages/batches
Annulla un batch di messaggi
POST/v1/messages/batches/{message_batch_id}/cancel
Elimina un batch di messaggi
DELETE/v1/messages/batches/{message_batch_id}
Recupera i risultati di un batch di messaggi
GET/v1/messages/batches/{message_batch_id}/results

BetaAgenti

Crea agente
POST/v1/agents
Elenca gli agenti
GET/v1/agents
Ottieni agente
GET/v1/agents/{agent_id}
Aggiorna agente
POST/v1/agents/{agent_id}
Archivia agente
POST/v1/agents/{agent_id}/archive

BetaAgentiVersioni

Elenca le versioni dell'agente
GET/v1/agents/{agent_id}/versions

BetaAmbienti

Crea ambiente
POST/v1/environments
Elenca gli ambienti
GET/v1/environments
Ottieni ambiente
GET/v1/environments/{environment_id}
Aggiorna ambiente
POST/v1/environments/{environment_id}
Elimina ambiente
DELETE/v1/environments/{environment_id}
Archivia ambiente
POST/v1/environments/{environment_id}/archive

BetaAmbientiLavoro

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

BetaSessioni

Crea sessione
POST/v1/sessions
Elenca le sessioni
GET/v1/sessions
Ottieni sessione
GET/v1/sessions/{session_id}
Aggiorna sessione
POST/v1/sessions/{session_id}
Elimina sessione
DELETE/v1/sessions/{session_id}
Archivia sessione
POST/v1/sessions/{session_id}/archive

BetaSessioniEventi

Elenca gli eventi
GET/v1/sessions/{session_id}/events
Invia eventi
POST/v1/sessions/{session_id}/events
Trasmetti eventi in streaming
GET/v1/sessions/{session_id}/events/stream

BetaSessioniRisorse

Aggiungi risorsa di sessione
POST/v1/sessions/{session_id}/resources
Elenca le risorse di sessione
GET/v1/sessions/{session_id}/resources
Ottieni risorsa di sessione
GET/v1/sessions/{session_id}/resources/{resource_id}
Aggiorna risorsa di sessione
POST/v1/sessions/{session_id}/resources/{resource_id}
Elimina risorsa di sessione
DELETE/v1/sessions/{session_id}/resources/{resource_id}

BetaSessioniThread

Elenca i thread di sessione
GET/v1/sessions/{session_id}/threads
Ottieni thread di sessione
GET/v1/sessions/{session_id}/threads/{thread_id}
Archivia thread di sessione
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

BetaSessioniThreadEventi

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

BetaDeployment

Crea deployment
POST/v1/deployments
Elenca i deployment
GET/v1/deployments
Ottieni deployment
GET/v1/deployments/{deployment_id}
Aggiorna deployment
POST/v1/deployments/{deployment_id}
Archivia deployment
POST/v1/deployments/{deployment_id}/archive
Esegui deployment ora
POST/v1/deployments/{deployment_id}/run
Sospendi deployment
POST/v1/deployments/{deployment_id}/pause
Riprendi deployment
POST/v1/deployments/{deployment_id}/unpause

BetaEsecuzioni del deployment

Elenca esecuzioni del deployment
GET/v1/deployment_runs
Ottieni esecuzione del deployment
GET/v1/deployment_runs/{deployment_run_id}

BetaVault

Crea vault
POST/v1/vaults
Elenca vault
GET/v1/vaults
Ottieni vault
GET/v1/vaults/{vault_id}
Aggiorna vault
POST/v1/vaults/{vault_id}
Elimina vault
DELETE/v1/vaults/{vault_id}
Archivia vault
POST/v1/vaults/{vault_id}/archive

BetaVaultCredenziali

Crea credenziale
POST/v1/vaults/{vault_id}/credentials
Elenca credenziali
GET/v1/vaults/{vault_id}/credentials
Ottieni credenziale
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Aggiorna credenziale
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Elimina credenziale
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Archivia credenziale
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Convalida credenziale
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate

BetaArchivi di memoria

Crea un archivio di memoria
POST/v1/memory_stores
Elenca archivi di memoria
GET/v1/memory_stores
Recupera un archivio di memoria
GET/v1/memory_stores/{memory_store_id}
Aggiorna un archivio di memoria
POST/v1/memory_stores/{memory_store_id}
Elimina un archivio di memoria
DELETE/v1/memory_stores/{memory_store_id}
Archivia un archivio di memoria
POST/v1/memory_stores/{memory_store_id}/archive

BetaArchivi di memoriaMemorie

Crea una memoria
POST/v1/memory_stores/{memory_store_id}/memories
Elenca memorie
GET/v1/memory_stores/{memory_store_id}/memories
Recupera una memoria
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Aggiorna una memoria
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Elimina una memoria
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}

BetaArchivi di memoriaVersioni della memoria

Elenca versioni della memoria
GET/v1/memory_stores/{memory_store_id}/memory_versions
Recupera una versione della memoria
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
Oscura una versione della memoria
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

BetaFile

Carica file
POST/v1/files
Elenca i file
GET/v1/files
Scarica file
GET/v1/files/{file_id}/content
Ottieni metadati del file
GET/v1/files/{file_id}
Elimina file
DELETE/v1/files/{file_id}

BetaSkill

Crea skill
POST/v1/skills
Elenca le skill
GET/v1/skills
Ottieni skill
GET/v1/skills/{skill_id}
Elimina skill
DELETE/v1/skills/{skill_id}

BetaSkillVersioni

Crea versione della skill
POST/v1/skills/{skill_id}/versions
Elenca le versioni della skill
GET/v1/skills/{skill_id}/versions
Scarica contenuto versione skill
GET/v1/skills/{skill_id}/versions/{version}/content
Ottieni versione della skill
GET/v1/skills/{skill_id}/versions/{version}
Elimina versione della skill
DELETE/v1/skills/{skill_id}/versions/{version}

BetaWebhook

Unwrap
Function
Parse Unverified
Function

BetaProfili utente

Crea profilo utente
POST/v1/user_profiles
Elenca profili utente
GET/v1/user_profiles
Ottieni profilo utente
GET/v1/user_profiles/{user_profile_id}
Aggiorna profilo utente
POST/v1/user_profiles/{user_profile_id}
Crea URL di registrazione
POST/v1/user_profiles/{user_profile_id}/enrollment_url

BetaDream

Crea un Dream
POST/v1/dreams
Elenca Dream
GET/v1/dreams
Ottieni un Dream
GET/v1/dreams/{dream_id}
Annulla un Dream
POST/v1/dreams/{dream_id}/cancel
Archivia un Dream
POST/v1/dreams/{dream_id}/archive

BetaTunnel

Crea tunnel
POST/v1/tunnels
Ottieni tunnel
GET/v1/tunnels/{tunnel_id}
Elenca tunnel
GET/v1/tunnels
Archivia tunnel
POST/v1/tunnels/{tunnel_id}/archive
Rivela token del tunnel
POST/v1/tunnels/{tunnel_id}/reveal_token
Ruota token del tunnel
POST/v1/tunnels/{tunnel_id}/rotate_token

BetaTunnelCertificati

Crea certificato del tunnel
POST/v1/tunnels/{tunnel_id}/certificates
Ottieni certificato del tunnel
GET/v1/tunnels/{tunnel_id}/certificates/{certificate_id}
Elenca certificati del tunnel
GET/v1/tunnels/{tunnel_id}/certificates
Archivia certificato del tunnel
POST/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

BetaOrganizzazione

Ottieni l'organizzazione corrente
GET/v1/organizations/me

BetaOrganizzazioneChiavi API

Elenca chiavi API
GET/v1/organizations/api_keys
Ottieni chiave API
GET/v1/organizations/api_keys/{api_key_id}
Aggiorna chiave API
POST/v1/organizations/api_keys/{api_key_id}

BetaOrganizzazioneChiavi esterne

Crea chiave esterna
POST/v1/organizations/external_keys
Elenca chiavi esterne
GET/v1/organizations/external_keys
Ottieni chiave esterna
GET/v1/organizations/external_keys/{external_key_id}
Aggiorna chiave esterna
POST/v1/organizations/external_keys/{external_key_id}
Elimina chiave esterna
DELETE/v1/organizations/external_keys/{external_key_id}
Convalida chiave esterna
POST/v1/organizations/external_keys/{external_key_id}/validate

BetaOrganizzazioneFederazioneEmittenti

Crea issuer di federazione
POST/v1/organizations/federation_issuers
Elenca issuer di federazione
GET/v1/organizations/federation_issuers
Ottieni issuer di federazione
GET/v1/organizations/federation_issuers/{federation_issuer_id}
Aggiorna issuer di federazione
POST/v1/organizations/federation_issuers/{federation_issuer_id}
Archivia issuer di federazione
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

BetaOrganizzazioneFederazioneRegole

Crea regola di federazione
POST/v1/organizations/federation_rules
Elenca regole di federazione
GET/v1/organizations/federation_rules
Ottieni regola di federazione
GET/v1/organizations/federation_rules/{federation_rule_id}
Aggiorna regola di federazione
POST/v1/organizations/federation_rules/{federation_rule_id}
Archivia regola di federazione
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

BetaOrganizzazioneFederazioneRegoleWorkspace

Aggiungi workspace alla regola di federazione
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Elenca workspace della regola di federazione
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Rimuovi workspace dalla regola di federazione
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

BetaOrganizzazioneInviti

Crea invito
POST/v1/organizations/invites
Elenca inviti
GET/v1/organizations/invites
Ottieni invito
GET/v1/organizations/invites/{invite_id}
Elimina invito
DELETE/v1/organizations/invites/{invite_id}

BetaOrganizzazioneService account

Crea service account
POST/v1/organizations/service_accounts
Elenca service account
GET/v1/organizations/service_accounts
Ottieni service account
GET/v1/organizations/service_accounts/{service_account_id}
Aggiorna service account
POST/v1/organizations/service_accounts/{service_account_id}
Archivia service account
POST/v1/organizations/service_accounts/{service_account_id}/archive

BetaOrganizzazioneService accountWorkspace

Aggiungi workspace al service account
POST/v1/organizations/service_accounts/{service_account_id}/workspaces
Elenca workspace per il service account
GET/v1/organizations/service_accounts/{service_account_id}/workspaces
Rimuovi workspace dal service account
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

BetaOrganizzazioneUtenti

Elenca utenti
GET/v1/organizations/users
Ottieni utente
GET/v1/organizations/users/{user_id}
Aggiorna utente
POST/v1/organizations/users/{user_id}
Rimuovi utente
DELETE/v1/organizations/users/{user_id}

BetaOrganizzazioneWorkspace

Elenca workspace
GET/v1/organizations/workspaces
Crea workspace
POST/v1/organizations/workspaces
Ottieni workspace
GET/v1/organizations/workspaces/{workspace_id}
Aggiorna workspace
POST/v1/organizations/workspaces/{workspace_id}
Archivia workspace
POST/v1/organizations/workspaces/{workspace_id}/archive

BetaOrganizzazioneWorkspaceLimiti di velocità

Elenca limiti di velocità del workspace
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

BetaOrganizzazioneWorkspaceMembri

Elenca membri del workspace
GET/v1/organizations/workspaces/{workspace_id}/members
Crea membro del workspace
POST/v1/organizations/workspaces/{workspace_id}/members
Ottieni membro del workspace
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Aggiorna membro del workspace
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Elimina membro del workspace
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

BetaOrganizzazioneWorkspaceService account

Elenca membri service account del workspace
GET/v1/organizations/workspaces/{workspace_id}/service_accounts
Crea membro service account del workspace
POST/v1/organizations/workspaces/{workspace_id}/service_accounts
Ottieni membro service account del workspace
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Aggiorna membro service account del workspace
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Elimina membro service account del workspace
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

BetaOrganizzazioneLimiti di velocità

Elenca limiti di velocità dell'organizzazione
GET/v1/organizations/rate_limits

BetaOrganizzazioneImpostazioni di conformità

Ottieni impostazioni di conformità
GET/v1/organizations/compliance_settings
Aggiorna impostazioni di conformità
POST/v1/organizations/compliance_settings