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

BetaModelle

Modelle auflisten
GET/v1/models
Ein Modell abrufen
GET/v1/models/{model_id}
Eine Nachricht erstellen
POST/v1/messages
Tokens in einer Nachricht zählen
POST/v1/messages/count_tokens

BetaNachrichtenBatches

Einen Message Batch erstellen
POST/v1/messages/batches
Einen Message Batch abrufen
GET/v1/messages/batches/{message_batch_id}
Message Batches auflisten
GET/v1/messages/batches
Einen Message Batch abbrechen
POST/v1/messages/batches/{message_batch_id}/cancel
Einen Message Batch löschen
DELETE/v1/messages/batches/{message_batch_id}
Ergebnisse eines Message Batch abrufen
GET/v1/messages/batches/{message_batch_id}/results

BetaAgenten

Agent erstellen
POST/v1/agents
Agenten auflisten
GET/v1/agents
Agent abrufen
GET/v1/agents/{agent_id}
Agent aktualisieren
POST/v1/agents/{agent_id}
Agent archivieren
POST/v1/agents/{agent_id}/archive

BetaAgentenVersionen

Agent-Versionen auflisten
GET/v1/agents/{agent_id}/versions

BetaUmgebungen

Umgebung erstellen
POST/v1/environments
Umgebungen auflisten
GET/v1/environments
Umgebung abrufen
GET/v1/environments/{environment_id}
Umgebung aktualisieren
POST/v1/environments/{environment_id}
Umgebung löschen
DELETE/v1/environments/{environment_id}
Umgebung archivieren
POST/v1/environments/{environment_id}/archive

BetaUmgebungenArbeit

Arbeitselement abrufen
GET/v1/environments/{environment_id}/work/{work_id}
Arbeit per Polling abfragen
GET/v1/environments/{environment_id}/work/poll
Arbeit bestätigen
POST/v1/environments/{environment_id}/work/{work_id}/ack
Heartbeat aufzeichnen
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat
Arbeit stoppen
POST/v1/environments/{environment_id}/work/{work_id}/stop
Arbeitselemente auflisten
GET/v1/environments/{environment_id}/work
Arbeitselement aktualisieren
POST/v1/environments/{environment_id}/work/{work_id}
Warteschlangenstatistiken abrufen
GET/v1/environments/{environment_id}/work/stats

BetaSitzungen

Session erstellen
POST/v1/sessions
Sessions auflisten
GET/v1/sessions
Session abrufen
GET/v1/sessions/{session_id}
Session aktualisieren
POST/v1/sessions/{session_id}
Session löschen
DELETE/v1/sessions/{session_id}
Session archivieren
POST/v1/sessions/{session_id}/archive

BetaSitzungenEvents

Events auflisten
GET/v1/sessions/{session_id}/events
Events senden
POST/v1/sessions/{session_id}/events
Events streamen
GET/v1/sessions/{session_id}/events/stream

BetaSitzungenRessourcen

Session-Ressource hinzufügen
POST/v1/sessions/{session_id}/resources
Session-Ressourcen auflisten
GET/v1/sessions/{session_id}/resources
Session-Ressource abrufen
GET/v1/sessions/{session_id}/resources/{resource_id}
Session-Ressource aktualisieren
POST/v1/sessions/{session_id}/resources/{resource_id}
Session-Ressource löschen
DELETE/v1/sessions/{session_id}/resources/{resource_id}

BetaSitzungenThreads

Session-Threads auflisten
GET/v1/sessions/{session_id}/threads
Session-Thread abrufen
GET/v1/sessions/{session_id}/threads/{thread_id}
Session-Thread archivieren
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

BetaSitzungenThreadsEvents

Session-Thread-Events auflisten
GET/v1/sessions/{session_id}/threads/{thread_id}/events
Session-Thread-Events streamen
GET/v1/sessions/{session_id}/threads/{thread_id}/stream
Deployment erstellen
POST/v1/deployments
Deployments auflisten
GET/v1/deployments
Deployment abrufen
GET/v1/deployments/{deployment_id}
Deployment aktualisieren
POST/v1/deployments/{deployment_id}
Deployment archivieren
POST/v1/deployments/{deployment_id}/archive
Deployment jetzt ausführen
POST/v1/deployments/{deployment_id}/run
Deployment pausieren
POST/v1/deployments/{deployment_id}/pause
Deployment fortsetzen
POST/v1/deployments/{deployment_id}/unpause
Deployment-Runs auflisten
GET/v1/deployment_runs
Deployment-Run abrufen
GET/v1/deployment_runs/{deployment_run_id}

BetaVaults

Vault erstellen
POST/v1/vaults
Vaults auflisten
GET/v1/vaults
Vault abrufen
GET/v1/vaults/{vault_id}
Vault aktualisieren
POST/v1/vaults/{vault_id}
Vault löschen
DELETE/v1/vaults/{vault_id}
Vault archivieren
POST/v1/vaults/{vault_id}/archive

BetaVaultsCredentials

Credential erstellen
POST/v1/vaults/{vault_id}/credentials
Credentials auflisten
GET/v1/vaults/{vault_id}/credentials
Credential abrufen
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Credential aktualisieren
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Credential löschen
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Credential archivieren
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Credential validieren
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate
Memory Store erstellen
POST/v1/memory_stores
Memory Stores auflisten
GET/v1/memory_stores
Memory Store abrufen
GET/v1/memory_stores/{memory_store_id}
Memory Store aktualisieren
POST/v1/memory_stores/{memory_store_id}
Memory Store löschen
DELETE/v1/memory_stores/{memory_store_id}
Memory Store archivieren
POST/v1/memory_stores/{memory_store_id}/archive

BetaMemory StoresMemories

Memory erstellen
POST/v1/memory_stores/{memory_store_id}/memories
Memories auflisten
GET/v1/memory_stores/{memory_store_id}/memories
Memory abrufen
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Memory aktualisieren
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Memory löschen
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}

BetaMemory StoresMemory-Versionen

Memory-Versionen auflisten
GET/v1/memory_stores/{memory_store_id}/memory_versions
Memory-Version abrufen
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
Memory-Version schwärzen
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

BetaDateien

Datei hochladen
POST/v1/files
Dateien auflisten
GET/v1/files
Datei herunterladen
GET/v1/files/{file_id}/content
Dateimetadaten abrufen
GET/v1/files/{file_id}
Datei löschen
DELETE/v1/files/{file_id}

BetaSkills

Skill erstellen
POST/v1/skills
Skills auflisten
GET/v1/skills
Skill abrufen
GET/v1/skills/{skill_id}
Skill löschen
DELETE/v1/skills/{skill_id}

BetaSkillsVersionen

Skill-Version erstellen
POST/v1/skills/{skill_id}/versions
Skill-Versionen auflisten
GET/v1/skills/{skill_id}/versions
Inhalt einer Skill-Version herunterladen
GET/v1/skills/{skill_id}/versions/{version}/content
Skill-Version abrufen
GET/v1/skills/{skill_id}/versions/{version}
Skill-Version löschen
DELETE/v1/skills/{skill_id}/versions/{version}

BetaWebhooks

Unwrap
Function
Parse Unverified
Function
Benutzerprofil erstellen
POST/v1/user_profiles
Benutzerprofile auflisten
GET/v1/user_profiles
Benutzerprofil abrufen
GET/v1/user_profiles/{user_profile_id}
Benutzerprofil aktualisieren
POST/v1/user_profiles/{user_profile_id}
Enrollment-URL erstellen
POST/v1/user_profiles/{user_profile_id}/enrollment_url

BetaDreams

Dream erstellen
POST/v1/dreams
Dreams auflisten
GET/v1/dreams
Dream abrufen
GET/v1/dreams/{dream_id}
Dream abbrechen
POST/v1/dreams/{dream_id}/cancel
Dream archivieren
POST/v1/dreams/{dream_id}/archive

BetaTunnel

Tunnel erstellen
POST/v1/tunnels
Tunnel abrufen
GET/v1/tunnels/{tunnel_id}
Tunnels auflisten
GET/v1/tunnels
Tunnel archivieren
POST/v1/tunnels/{tunnel_id}/archive
Tunnel-Token anzeigen
POST/v1/tunnels/{tunnel_id}/reveal_token
Tunnel-Token rotieren
POST/v1/tunnels/{tunnel_id}/rotate_token

BetaTunnelZertifikate

Tunnel-Zertifikat erstellen
POST/v1/tunnels/{tunnel_id}/certificates
Tunnel-Zertifikat abrufen
GET/v1/tunnels/{tunnel_id}/certificates/{certificate_id}
Tunnel-Zertifikate auflisten
GET/v1/tunnels/{tunnel_id}/certificates
Tunnel-Zertifikat archivieren
POST/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive
Aktuelle Organisation abrufen
GET/v1/organizations/me

BetaOrganisationAPI-Keys

API-Keys auflisten
GET/v1/organizations/api_keys
API-Key abrufen
GET/v1/organizations/api_keys/{api_key_id}
API-Key aktualisieren
POST/v1/organizations/api_keys/{api_key_id}

BetaOrganisationExterne Schlüssel

Externen Schlüssel erstellen
POST/v1/organizations/external_keys
Externe Schlüssel auflisten
GET/v1/organizations/external_keys
Externen Schlüssel abrufen
GET/v1/organizations/external_keys/{external_key_id}
Externen Schlüssel aktualisieren
POST/v1/organizations/external_keys/{external_key_id}
Externen Schlüssel löschen
DELETE/v1/organizations/external_keys/{external_key_id}
Externen Schlüssel validieren
POST/v1/organizations/external_keys/{external_key_id}/validate

BetaOrganisationFederationIssuer

Federation-Issuer erstellen
POST/v1/organizations/federation_issuers
Federation-Issuer auflisten
GET/v1/organizations/federation_issuers
Federation-Issuer abrufen
GET/v1/organizations/federation_issuers/{federation_issuer_id}
Federation-Issuer aktualisieren
POST/v1/organizations/federation_issuers/{federation_issuer_id}
Federation-Issuer archivieren
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

BetaOrganisationFederationRegeln

Federation-Regel erstellen
POST/v1/organizations/federation_rules
Federation-Regeln auflisten
GET/v1/organizations/federation_rules
Federation-Regel abrufen
GET/v1/organizations/federation_rules/{federation_rule_id}
Federation-Regel aktualisieren
POST/v1/organizations/federation_rules/{federation_rule_id}
Federation-Regel archivieren
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

BetaOrganisationFederationRegelnWorkspaces

Workspace zu Federation-Regel hinzufügen
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Workspaces einer Federation-Regel auflisten
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Workspace aus Federation-Regel entfernen
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

BetaOrganisationEinladungen

Einladung erstellen
POST/v1/organizations/invites
Einladungen auflisten
GET/v1/organizations/invites
Einladung abrufen
GET/v1/organizations/invites/{invite_id}
Einladung löschen
DELETE/v1/organizations/invites/{invite_id}

BetaOrganisationService-Accounts

Service-Account erstellen
POST/v1/organizations/service_accounts
Service-Accounts auflisten
GET/v1/organizations/service_accounts
Service-Account abrufen
GET/v1/organizations/service_accounts/{service_account_id}
Service-Account aktualisieren
POST/v1/organizations/service_accounts/{service_account_id}
Service-Account archivieren
POST/v1/organizations/service_accounts/{service_account_id}/archive

BetaOrganisationService-AccountsWorkspaces

Workspace zu Service-Account hinzufügen
POST/v1/organizations/service_accounts/{service_account_id}/workspaces
Workspaces für Service-Account auflisten
GET/v1/organizations/service_accounts/{service_account_id}/workspaces
Workspace aus Service-Account entfernen
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

BetaOrganisationBenutzer

Benutzer auflisten
GET/v1/organizations/users
Benutzer abrufen
GET/v1/organizations/users/{user_id}
Benutzer aktualisieren
POST/v1/organizations/users/{user_id}
Benutzer entfernen
DELETE/v1/organizations/users/{user_id}

BetaOrganisationWorkspaces

Workspaces auflisten
GET/v1/organizations/workspaces
Workspace erstellen
POST/v1/organizations/workspaces
Workspace abrufen
GET/v1/organizations/workspaces/{workspace_id}
Workspace aktualisieren
POST/v1/organizations/workspaces/{workspace_id}
Workspace archivieren
POST/v1/organizations/workspaces/{workspace_id}/archive

BetaOrganisationWorkspacesRatenlimits

Workspace-Ratenlimits auflisten
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

BetaOrganisationWorkspacesMitglieder

Workspace-Mitglieder auflisten
GET/v1/organizations/workspaces/{workspace_id}/members
Workspace-Mitglied erstellen
POST/v1/organizations/workspaces/{workspace_id}/members
Workspace-Mitglied abrufen
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Workspace-Mitglied aktualisieren
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Workspace-Mitglied löschen
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

BetaOrganisationWorkspacesService-Accounts

Service-Accounts als Workspace-Mitglieder auflisten
GET/v1/organizations/workspaces/{workspace_id}/service_accounts
Service-Account als Workspace-Mitglied erstellen
POST/v1/organizations/workspaces/{workspace_id}/service_accounts
Service-Account als Workspace-Mitglied abrufen
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Service-Account als Workspace-Mitglied aktualisieren
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Service-Account als Workspace-Mitglied löschen
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

BetaOrganisationRatenlimits

Ratenlimits der Organisation auflisten
GET/v1/organizations/rate_limits

BetaOrganisationCompliance-Einstellungen

Compliance-Einstellungen abrufen
GET/v1/organizations/compliance_settings
Compliance-Einstellungen aktualisieren
POST/v1/organizations/compliance_settings