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"

BetaModelle

Modelle auflisten
$ ant beta:models list
GET/v1/models
Ein Modell abrufen
$ ant beta:models retrieve
GET/v1/models/{model_id}

BetaNachrichten

Eine Nachricht erstellen
$ ant beta:messages create
POST/v1/messages
Tokens in einer Nachricht zählen
$ ant beta:messages count-tokens
POST/v1/messages/count_tokens

BetaNachrichtenBatches

Einen Message Batch erstellen
$ ant beta:messages:batches create
POST/v1/messages/batches
Einen Message Batch abrufen
$ ant beta:messages:batches retrieve
GET/v1/messages/batches/{message_batch_id}
Message Batches auflisten
$ ant beta:messages:batches list
GET/v1/messages/batches
Einen Message Batch abbrechen
$ ant beta:messages:batches cancel
POST/v1/messages/batches/{message_batch_id}/cancel
Einen Message Batch löschen
$ ant beta:messages:batches delete
DELETE/v1/messages/batches/{message_batch_id}
Ergebnisse eines Message Batch abrufen
$ ant beta:messages:batches results
GET/v1/messages/batches/{message_batch_id}/results

BetaAgenten

Agent erstellen
$ ant beta:agents create
POST/v1/agents
Agenten auflisten
$ ant beta:agents list
GET/v1/agents
Agent abrufen
$ ant beta:agents retrieve
GET/v1/agents/{agent_id}
Agent aktualisieren
$ ant beta:agents update
POST/v1/agents/{agent_id}
Agent archivieren
$ ant beta:agents archive
POST/v1/agents/{agent_id}/archive

BetaAgentenVersionen

Agent-Versionen auflisten
$ ant beta:agents:versions list
GET/v1/agents/{agent_id}/versions

BetaUmgebungen

Umgebung erstellen
$ ant beta:environments create
POST/v1/environments
Umgebungen auflisten
$ ant beta:environments list
GET/v1/environments
Umgebung abrufen
$ ant beta:environments retrieve
GET/v1/environments/{environment_id}
Umgebung aktualisieren
$ ant beta:environments update
POST/v1/environments/{environment_id}
Umgebung löschen
$ ant beta:environments delete
DELETE/v1/environments/{environment_id}
Umgebung archivieren
$ ant beta:environments archive
POST/v1/environments/{environment_id}/archive

BetaUmgebungenArbeit

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

BetaSitzungen

Session erstellen
$ ant beta:sessions create
POST/v1/sessions
Sessions auflisten
$ ant beta:sessions list
GET/v1/sessions
Session abrufen
$ ant beta:sessions retrieve
GET/v1/sessions/{session_id}
Session aktualisieren
$ ant beta:sessions update
POST/v1/sessions/{session_id}
Session löschen
$ ant beta:sessions delete
DELETE/v1/sessions/{session_id}
Session archivieren
$ ant beta:sessions archive
POST/v1/sessions/{session_id}/archive

BetaSitzungenEvents

Events auflisten
$ ant beta:sessions:events list
GET/v1/sessions/{session_id}/events
Events senden
$ ant beta:sessions:events send
POST/v1/sessions/{session_id}/events
Events streamen
$ ant beta:sessions:events stream
GET/v1/sessions/{session_id}/events/stream

BetaSitzungenRessourcen

Session-Ressource hinzufügen
$ ant beta:sessions:resources add
POST/v1/sessions/{session_id}/resources
Session-Ressourcen auflisten
$ ant beta:sessions:resources list
GET/v1/sessions/{session_id}/resources
Session-Ressource abrufen
$ ant beta:sessions:resources retrieve
GET/v1/sessions/{session_id}/resources/{resource_id}
Session-Ressource aktualisieren
$ ant beta:sessions:resources update
POST/v1/sessions/{session_id}/resources/{resource_id}
Session-Ressource löschen
$ ant beta:sessions:resources delete
DELETE/v1/sessions/{session_id}/resources/{resource_id}

BetaSitzungenThreads

Session-Threads auflisten
$ ant beta:sessions:threads list
GET/v1/sessions/{session_id}/threads
Session-Thread abrufen
$ ant beta:sessions:threads retrieve
GET/v1/sessions/{session_id}/threads/{thread_id}
Session-Thread archivieren
$ ant beta:sessions:threads archive
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

BetaSitzungenThreadsEvents

Session-Thread-Events auflisten
$ ant beta:sessions:threads:events list
GET/v1/sessions/{session_id}/threads/{thread_id}/events
Session-Thread-Events streamen
$ ant beta:sessions:threads:events stream
GET/v1/sessions/{session_id}/threads/{thread_id}/stream

BetaDeployments

Deployment erstellen
$ ant beta:deployments create
POST/v1/deployments
Deployments auflisten
$ ant beta:deployments list
GET/v1/deployments
Deployment abrufen
$ ant beta:deployments retrieve
GET/v1/deployments/{deployment_id}
Deployment aktualisieren
$ ant beta:deployments update
POST/v1/deployments/{deployment_id}
Deployment archivieren
$ ant beta:deployments archive
POST/v1/deployments/{deployment_id}/archive
Deployment jetzt ausführen
$ ant beta:deployments run
POST/v1/deployments/{deployment_id}/run
Deployment pausieren
$ ant beta:deployments pause
POST/v1/deployments/{deployment_id}/pause
Deployment fortsetzen
$ ant beta:deployments unpause
POST/v1/deployments/{deployment_id}/unpause

BetaDeployment-Runs

Deployment-Runs auflisten
$ ant beta:deployment-runs list
GET/v1/deployment_runs
Deployment-Run abrufen
$ ant beta:deployment-runs retrieve
GET/v1/deployment_runs/{deployment_run_id}

BetaVaults

Vault erstellen
$ ant beta:vaults create
POST/v1/vaults
Vaults auflisten
$ ant beta:vaults list
GET/v1/vaults
Vault abrufen
$ ant beta:vaults retrieve
GET/v1/vaults/{vault_id}
Vault aktualisieren
$ ant beta:vaults update
POST/v1/vaults/{vault_id}
Vault löschen
$ ant beta:vaults delete
DELETE/v1/vaults/{vault_id}
Vault archivieren
$ ant beta:vaults archive
POST/v1/vaults/{vault_id}/archive

BetaVaultsCredentials

Credential erstellen
$ ant beta:vaults:credentials create
POST/v1/vaults/{vault_id}/credentials
Credentials auflisten
$ ant beta:vaults:credentials list
GET/v1/vaults/{vault_id}/credentials
Credential abrufen
$ ant beta:vaults:credentials retrieve
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Credential aktualisieren
$ ant beta:vaults:credentials update
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Credential löschen
$ ant beta:vaults:credentials delete
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Credential archivieren
$ ant beta:vaults:credentials archive
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Credential validieren
$ ant beta:vaults:credentials mcp-oauth-validate
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate

BetaMemory Stores

Memory Store erstellen
$ ant beta:memory-stores create
POST/v1/memory_stores
Memory Stores auflisten
$ ant beta:memory-stores list
GET/v1/memory_stores
Memory Store abrufen
$ ant beta:memory-stores retrieve
GET/v1/memory_stores/{memory_store_id}
Memory Store aktualisieren
$ ant beta:memory-stores update
POST/v1/memory_stores/{memory_store_id}
Memory Store löschen
$ ant beta:memory-stores delete
DELETE/v1/memory_stores/{memory_store_id}
Memory Store archivieren
$ ant beta:memory-stores archive
POST/v1/memory_stores/{memory_store_id}/archive

BetaMemory StoresMemories

Memory erstellen
$ ant beta:memory-stores:memories create
POST/v1/memory_stores/{memory_store_id}/memories
Memories auflisten
$ ant beta:memory-stores:memories list
GET/v1/memory_stores/{memory_store_id}/memories
Memory abrufen
$ ant beta:memory-stores:memories retrieve
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Memory aktualisieren
$ ant beta:memory-stores:memories update
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Memory löschen
$ ant beta:memory-stores:memories delete
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}

BetaMemory StoresMemory-Versionen

Memory-Versionen auflisten
$ ant beta:memory-stores:memory-versions list
GET/v1/memory_stores/{memory_store_id}/memory_versions
Memory-Version abrufen
$ ant beta:memory-stores:memory-versions retrieve
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
Memory-Version schwärzen
$ ant beta:memory-stores:memory-versions redact
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

BetaDateien

Datei hochladen
$ ant beta:files upload
POST/v1/files
Dateien auflisten
$ ant beta:files list
GET/v1/files
Datei herunterladen
$ ant beta:files download
GET/v1/files/{file_id}/content
Dateimetadaten abrufen
$ ant beta:files retrieve-metadata
GET/v1/files/{file_id}
Datei löschen
$ ant beta:files delete
DELETE/v1/files/{file_id}

BetaSkills

Skill erstellen
$ ant beta:skills create
POST/v1/skills
Skills auflisten
$ ant beta:skills list
GET/v1/skills
Skill abrufen
$ ant beta:skills retrieve
GET/v1/skills/{skill_id}
Skill löschen
$ ant beta:skills delete
DELETE/v1/skills/{skill_id}

BetaSkillsVersionen

Skill-Version erstellen
$ ant beta:skills:versions create
POST/v1/skills/{skill_id}/versions
Skill-Versionen auflisten
$ ant beta:skills:versions list
GET/v1/skills/{skill_id}/versions
Inhalt einer Skill-Version herunterladen
$ ant beta:skills:versions download
GET/v1/skills/{skill_id}/versions/{version}/content
Skill-Version abrufen
$ ant beta:skills:versions retrieve
GET/v1/skills/{skill_id}/versions/{version}
Skill-Version löschen
$ ant beta:skills:versions delete
DELETE/v1/skills/{skill_id}/versions/{version}

BetaBenutzerprofile

Benutzerprofil erstellen
$ ant beta:user-profiles create
POST/v1/user_profiles
Benutzerprofile auflisten
$ ant beta:user-profiles list
GET/v1/user_profiles
Benutzerprofil abrufen
$ ant beta:user-profiles retrieve
GET/v1/user_profiles/{user_profile_id}
Benutzerprofil aktualisieren
$ ant beta:user-profiles update
POST/v1/user_profiles/{user_profile_id}
Enrollment-URL erstellen
$ ant beta:user-profiles create-enrollment-url
POST/v1/user_profiles/{user_profile_id}/enrollment_url

BetaDreams

Dream erstellen
$ ant beta:dreams create
POST/v1/dreams
Dreams auflisten
$ ant beta:dreams list
GET/v1/dreams
Dream abrufen
$ ant beta:dreams retrieve
GET/v1/dreams/{dream_id}
Dream abbrechen
$ ant beta:dreams cancel
POST/v1/dreams/{dream_id}/cancel
Dream archivieren
$ ant beta:dreams archive
POST/v1/dreams/{dream_id}/archive

BetaTunnel

Tunnel erstellen
$ ant beta:tunnels create
POST/v1/tunnels
Tunnel abrufen
$ ant beta:tunnels retrieve
GET/v1/tunnels/{tunnel_id}
Tunnels auflisten
$ ant beta:tunnels list
GET/v1/tunnels
Tunnel archivieren
$ ant beta:tunnels archive
POST/v1/tunnels/{tunnel_id}/archive
Tunnel-Token anzeigen
$ ant beta:tunnels reveal-token
POST/v1/tunnels/{tunnel_id}/reveal_token
Tunnel-Token rotieren
$ ant beta:tunnels rotate-token
POST/v1/tunnels/{tunnel_id}/rotate_token

BetaTunnelZertifikate

Tunnel-Zertifikat erstellen
$ ant beta:tunnels:certificates create
POST/v1/tunnels/{tunnel_id}/certificates
Tunnel-Zertifikat abrufen
$ ant beta:tunnels:certificates retrieve
GET/v1/tunnels/{tunnel_id}/certificates/{certificate_id}
Tunnel-Zertifikate auflisten
$ ant beta:tunnels:certificates list
GET/v1/tunnels/{tunnel_id}/certificates
Tunnel-Zertifikat archivieren
$ ant beta:tunnels:certificates archive
POST/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

BetaOrganisation

Aktuelle Organisation abrufen
$ ant beta:organization retrieve
GET/v1/organizations/me

BetaOrganisationAPI-Keys

API-Keys auflisten
$ ant beta:organization:api-keys list
GET/v1/organizations/api_keys
API-Key abrufen
$ ant beta:organization:api-keys retrieve
GET/v1/organizations/api_keys/{api_key_id}
API-Key aktualisieren
$ ant beta:organization:api-keys update
POST/v1/organizations/api_keys/{api_key_id}

BetaOrganisationExterne Schlüssel

Externen Schlüssel erstellen
$ ant beta:organization:external-keys create
POST/v1/organizations/external_keys
Externe Schlüssel auflisten
$ ant beta:organization:external-keys list
GET/v1/organizations/external_keys
Externen Schlüssel abrufen
$ ant beta:organization:external-keys retrieve
GET/v1/organizations/external_keys/{external_key_id}
Externen Schlüssel aktualisieren
$ ant beta:organization:external-keys update
POST/v1/organizations/external_keys/{external_key_id}
Externen Schlüssel löschen
$ ant beta:organization:external-keys delete
DELETE/v1/organizations/external_keys/{external_key_id}
Externen Schlüssel validieren
$ ant beta:organization:external-keys validate
POST/v1/organizations/external_keys/{external_key_id}/validate

BetaOrganisationFederationIssuer

Federation-Issuer erstellen
$ ant beta:organization:federation:issuers create
POST/v1/organizations/federation_issuers
Federation-Issuer auflisten
$ ant beta:organization:federation:issuers list
GET/v1/organizations/federation_issuers
Federation-Issuer abrufen
$ ant beta:organization:federation:issuers retrieve
GET/v1/organizations/federation_issuers/{federation_issuer_id}
Federation-Issuer aktualisieren
$ ant beta:organization:federation:issuers update
POST/v1/organizations/federation_issuers/{federation_issuer_id}
Federation-Issuer archivieren
$ ant beta:organization:federation:issuers archive
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

BetaOrganisationFederationRegeln

Federation-Regel erstellen
$ ant beta:organization:federation:rules create
POST/v1/organizations/federation_rules
Federation-Regeln auflisten
$ ant beta:organization:federation:rules list
GET/v1/organizations/federation_rules
Federation-Regel abrufen
$ ant beta:organization:federation:rules retrieve
GET/v1/organizations/federation_rules/{federation_rule_id}
Federation-Regel aktualisieren
$ ant beta:organization:federation:rules update
POST/v1/organizations/federation_rules/{federation_rule_id}
Federation-Regel archivieren
$ ant beta:organization:federation:rules archive
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

BetaOrganisationFederationRegelnWorkspaces

Workspace zu Federation-Regel hinzufügen
$ ant beta:organization:federation:rules:workspaces add
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Workspaces einer Federation-Regel auflisten
$ ant beta:organization:federation:rules:workspaces list
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Workspace aus Federation-Regel entfernen
$ ant beta:organization:federation:rules:workspaces remove
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

BetaOrganisationEinladungen

Einladung erstellen
$ ant beta:organization:invites create
POST/v1/organizations/invites
Einladungen auflisten
$ ant beta:organization:invites list
GET/v1/organizations/invites
Einladung abrufen
$ ant beta:organization:invites retrieve
GET/v1/organizations/invites/{invite_id}
Einladung löschen
$ ant beta:organization:invites delete
DELETE/v1/organizations/invites/{invite_id}

BetaOrganisationService-Accounts

Service-Account erstellen
$ ant beta:organization:service-accounts create
POST/v1/organizations/service_accounts
Service-Accounts auflisten
$ ant beta:organization:service-accounts list
GET/v1/organizations/service_accounts
Service-Account abrufen
$ ant beta:organization:service-accounts retrieve
GET/v1/organizations/service_accounts/{service_account_id}
Service-Account aktualisieren
$ ant beta:organization:service-accounts update
POST/v1/organizations/service_accounts/{service_account_id}
Service-Account archivieren
$ ant beta:organization:service-accounts archive
POST/v1/organizations/service_accounts/{service_account_id}/archive

BetaOrganisationService-AccountsWorkspaces

Workspace zu Service-Account hinzufügen
$ ant beta:organization:service-accounts:workspaces add
POST/v1/organizations/service_accounts/{service_account_id}/workspaces
Workspaces für Service-Account auflisten
$ ant beta:organization:service-accounts:workspaces list
GET/v1/organizations/service_accounts/{service_account_id}/workspaces
Workspace aus Service-Account entfernen
$ ant beta:organization:service-accounts:workspaces remove
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

BetaOrganisationBenutzer

Benutzer auflisten
$ ant beta:organization:users list
GET/v1/organizations/users
Benutzer abrufen
$ ant beta:organization:users retrieve
GET/v1/organizations/users/{user_id}
Benutzer aktualisieren
$ ant beta:organization:users update
POST/v1/organizations/users/{user_id}
Benutzer entfernen
$ ant beta:organization:users remove
DELETE/v1/organizations/users/{user_id}

BetaOrganisationWorkspaces

Workspaces auflisten
$ ant beta:organization:workspaces list
GET/v1/organizations/workspaces
Workspace erstellen
$ ant beta:organization:workspaces create
POST/v1/organizations/workspaces
Workspace abrufen
$ ant beta:organization:workspaces retrieve
GET/v1/organizations/workspaces/{workspace_id}
Workspace aktualisieren
$ ant beta:organization:workspaces update
POST/v1/organizations/workspaces/{workspace_id}
Workspace archivieren
$ ant beta:organization:workspaces archive
POST/v1/organizations/workspaces/{workspace_id}/archive

BetaOrganisationWorkspacesRatenlimits

Workspace-Ratenlimits auflisten
$ ant beta:organization:workspaces:rate-limits list
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

BetaOrganisationWorkspacesMitglieder

Workspace-Mitglieder auflisten
$ ant beta:organization:workspaces:members list
GET/v1/organizations/workspaces/{workspace_id}/members
Workspace-Mitglied erstellen
$ ant beta:organization:workspaces:members add
POST/v1/organizations/workspaces/{workspace_id}/members
Workspace-Mitglied abrufen
$ ant beta:organization:workspaces:members retrieve
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Workspace-Mitglied aktualisieren
$ ant beta:organization:workspaces:members update
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Workspace-Mitglied löschen
$ ant beta:organization:workspaces:members remove
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

BetaOrganisationWorkspacesService-Accounts

Service-Accounts als Workspace-Mitglieder auflisten
$ ant beta:organization:workspaces:service-accounts list
GET/v1/organizations/workspaces/{workspace_id}/service_accounts
Service-Account als Workspace-Mitglied erstellen
$ ant beta:organization:workspaces:service-accounts add
POST/v1/organizations/workspaces/{workspace_id}/service_accounts
Service-Account als Workspace-Mitglied abrufen
$ ant beta:organization:workspaces:service-accounts retrieve
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Service-Account als Workspace-Mitglied aktualisieren
$ ant beta:organization:workspaces:service-accounts update
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Service-Account als Workspace-Mitglied löschen
$ ant beta:organization:workspaces:service-accounts remove
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

BetaOrganisationRatenlimits

Ratenlimits der Organisation auflisten
$ ant beta:organization:rate-limits list
GET/v1/organizations/rate_limits

BetaOrganisationCompliance-Einstellungen

Compliance-Einstellungen abrufen
$ ant beta:organization:compliance-settings retrieve
GET/v1/organizations/compliance_settings
Compliance-Einstellungen aktualisieren
$ ant beta:organization:compliance-settings update
POST/v1/organizations/compliance_settings