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 43 more
One of the following:
BetaAPIError object{ type: "api_error", message }
type: "api_error"
defaultapi_error
message: string
defaultInternal server error
BetaAuthenticationError object{ type: "authentication_error", message }
type: "authentication_error"
defaultauthentication_error
message: string
defaultAuthentication error
BetaBillingError object{ type: "billing_error", message }
type: "billing_error"
defaultbilling_error
message: string
defaultBilling error
BetaCurrency = "USD"
BetaError = BetaInvalidRequestError or BetaAuthenticationError or BetaBillingError or 6 more
One of the following:
BetaErrorResponse object{ type: "error", error, request_id }
type: "error"
defaulterror
error: BetaError
One of the following:
request_id: string or null
BetaGatewayTimeoutError object{ type: "timeout_error", message }
type: "timeout_error"
defaulttimeout_error
message: string
defaultRequest timeout
BetaInvalidRequestError object{ type: "invalid_request_error", message }
type: "invalid_request_error"
defaultinvalid_request_error
message: string
defaultInvalid request
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{ type: "not_found_error", message }
type: "not_found_error"
defaultnot_found_error
message: string
defaultNot found
BetaOverloadedError object{ type: "overloaded_error", message }
type: "overloaded_error"
defaultoverloaded_error
message: string
defaultOverloaded
BetaPermissionError object{ type: "permission_error", message }
type: "permission_error"
defaultpermission_error
message: string
defaultPermission denied
BetaRateLimitError object{ type: "rate_limit_error", message }
type: "rate_limit_error"
defaultrate_limit_error
message: string
defaultRate limited

BetaModelle

Modelle auflisten
GET/v1/models

Liste verfügbare Modelle auf.

Ein Modell abrufen
GET/v1/models/{model_id}

Rufe ein bestimmtes Modell ab.

BetaNachrichten

Eine Nachricht erstellen
POST/v1/messages

Sende eine strukturierte Liste von Eingabenachrichten mit Text- und/oder Bildinhalten, und das Modell generiert die nächste Nachricht in der Konversation.

Tokens in einer Nachricht zählen
POST/v1/messages/count_tokens

Zähle die Anzahl der Tokens in einer Nachricht.

BetaNachrichtenBatches

Einen Message Batch erstellen
POST/v1/messages/batches

Sende einen Batch von Anfragen zur Erstellung von Nachrichten.

Einen Message Batch abrufen
GET/v1/messages/batches/{message_batch_id}

Dieser Endpunkt ist idempotent und kann verwendet werden, um den Abschluss eines Message Batch per Polling abzufragen. Um auf die Ergebnisse eines Message Batch zuzugreifen, sende eine Anfrage an die im Feld results_url der Antwort angegebene URL.

Message Batches auflisten
GET/v1/messages/batches

Liste alle Message Batches innerhalb eines Workspace auf. Die zuletzt erstellten Batches werden zuerst zurückgegeben.

Einen Message Batch abbrechen
POST/v1/messages/batches/{message_batch_id}/cancel

Batches können jederzeit vor Ende der Verarbeitung abgebrochen werden. Sobald der Abbruch eingeleitet wurde, wechselt der Batch in den Zustand canceling; in dieser Zeit kann das System laufende, nicht unterbrechbare Anfragen noch abschließen, bevor der Abbruch finalisiert wird.

Einen Message Batch löschen
DELETE/v1/messages/batches/{message_batch_id}

Lösche einen Message Batch.

Ergebnisse eines Message Batch abrufen
GET/v1/messages/batches/{message_batch_id}/results

Streamt die Ergebnisse eines Message Batch als .jsonl-Datei.

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

Erstelle eine neue Umgebung mit der angegebenen Konfiguration.

Umgebungen auflisten
GET/v1/environments

Liste Umgebungen mit Unterstützung für Paginierung auf.

Umgebung abrufen
GET/v1/environments/{environment_id}

Rufe eine bestimmte Umgebung anhand ihrer ID ab.

Umgebung aktualisieren
POST/v1/environments/{environment_id}

Aktualisiere die Konfiguration einer bestehenden Umgebung.

Umgebung löschen
DELETE/v1/environments/{environment_id}

Lösche eine Umgebung anhand ihrer ID. Gibt eine Bestätigung der Löschung zurück.

Umgebung archivieren
POST/v1/environments/{environment_id}/archive

Archiviere eine Umgebung anhand ihrer ID. Archivierte Umgebungen können nicht zum Erstellen neuer Sessions verwendet werden.

BetaUmgebungenArbeit

Arbeitselement abrufen
GET/v1/environments/{environment_id}/work/{work_id}

Hinweis: Diese Endpunkte werden automatisch vom vorgefertigten Environment-Worker aufgerufen, der in den SDKs und der CLI bereitgestellt wird, um Sessions mit selbst gehosteten Sandbox-Umgebungen zu orchestrieren. Sie sind hier als Referenz aufgeführt; du musst sie nicht direkt aufrufen.

Arbeit per Polling abfragen
GET/v1/environments/{environment_id}/work/poll

Hinweis: Diese Endpunkte werden automatisch vom vorgefertigten Environment-Worker aufgerufen, der in den SDKs und der CLI bereitgestellt wird, um Sessions mit selbst gehosteten Sandbox-Umgebungen zu orchestrieren. Sie sind hier als Referenz aufgeführt; du musst sie nicht direkt aufrufen.

Arbeit bestätigen
POST/v1/environments/{environment_id}/work/{work_id}/ack

Hinweis: Diese Endpunkte werden automatisch vom vorgefertigten Environment-Worker aufgerufen, der in den SDKs und der CLI bereitgestellt wird, um Sessions mit selbst gehosteten Sandbox-Umgebungen zu orchestrieren. Sie sind hier als Referenz aufgeführt; du musst sie nicht direkt aufrufen.

Heartbeat aufzeichnen
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat

Hinweis: Diese Endpunkte werden automatisch vom vorgefertigten Environment-Worker aufgerufen, der in den SDKs und der CLI bereitgestellt wird, um Sessions mit selbst gehosteten Sandbox-Umgebungen zu orchestrieren. Sie sind hier als Referenz aufgeführt; du musst sie nicht direkt aufrufen.

Arbeit stoppen
POST/v1/environments/{environment_id}/work/{work_id}/stop

Hinweis: Diese Endpunkte werden automatisch vom vorgefertigten Environment-Worker aufgerufen, der in den SDKs und der CLI bereitgestellt wird, um Sessions mit selbst gehosteten Sandbox-Umgebungen zu orchestrieren. Sie sind hier als Referenz aufgeführt; du musst sie nicht direkt aufrufen.

Arbeitselemente auflisten
GET/v1/environments/{environment_id}/work

Hinweis: Diese Endpunkte werden automatisch vom vorgefertigten Environment-Worker aufgerufen, der in den SDKs und der CLI bereitgestellt wird, um Sessions mit selbst gehosteten Sandbox-Umgebungen zu orchestrieren. Sie sind hier als Referenz aufgeführt; du musst sie nicht direkt aufrufen.

Arbeitselement aktualisieren
POST/v1/environments/{environment_id}/work/{work_id}

Hinweis: Diese Endpunkte werden automatisch vom vorgefertigten Environment-Worker aufgerufen, der in den SDKs und der CLI bereitgestellt wird, um Sessions mit selbst gehosteten Sandbox-Umgebungen zu orchestrieren. Sie sind hier als Referenz aufgeführt; du musst sie nicht direkt aufrufen.

Warteschlangenstatistiken abrufen
GET/v1/environments/{environment_id}/work/stats

Rufe Statistiken über die Arbeitswarteschlange einer Umgebung ab.

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

BetaDeployments

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

BetaDeployment-Runs

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

BetaVaultsAnmeldedaten

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

BetaMemory Stores

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

Lädt den Inhalt einer Skill-Version als ZIP-Archiv herunter.

Skill-Version abrufen
GET/v1/skills/{skill_id}/versions/{version}
Skill-Version löschen
DELETE/v1/skills/{skill_id}/versions/{version}

BetaBenutzerprofile

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

Die Tunnels API befindet sich in der "Research Preview" (Forschungsvorschau). Sie erfordert den Header anthropic-beta: mcp-tunnels-2026-06-22 und kann sich ohne Abkündigungsfrist ändern. Sie ersetzt die Admin-API-Endpunkte unter /v1/organizations/tunnels, die während eines Migrationszeitraums weiterhin verfügbar bleiben.

Tunnel abrufen
GET/v1/tunnels/{tunnel_id}

Die Tunnels API befindet sich in der "Research Preview" (Forschungsvorschau). Sie erfordert den Header anthropic-beta: mcp-tunnels-2026-06-22 und kann sich ohne Abkündigungsfrist ändern. Sie ersetzt die Admin-API-Endpunkte unter /v1/organizations/tunnels, die während eines Migrationszeitraums weiterhin verfügbar bleiben.

Tunnels auflisten
GET/v1/tunnels

Die Tunnels API befindet sich in der "Research Preview" (Forschungsvorschau). Sie erfordert den Header anthropic-beta: mcp-tunnels-2026-06-22 und kann sich ohne Abkündigungsfrist ändern. Sie ersetzt die Admin-API-Endpunkte unter /v1/organizations/tunnels, die während eines Migrationszeitraums weiterhin verfügbar bleiben.

Tunnel archivieren
POST/v1/tunnels/{tunnel_id}/archive

Die Tunnels API befindet sich in der "Research Preview" (Forschungsvorschau). Sie erfordert den Header anthropic-beta: mcp-tunnels-2026-06-22 und kann sich ohne Abkündigungsfrist ändern. Sie ersetzt die Admin-API-Endpunkte unter /v1/organizations/tunnels, die während eines Migrationszeitraums weiterhin verfügbar bleiben.

Tunnel-Token anzeigen
POST/v1/tunnels/{tunnel_id}/reveal_token

Die Tunnels API befindet sich in der "Research Preview" (Forschungsvorschau). Sie erfordert den Header anthropic-beta: mcp-tunnels-2026-06-22 und kann sich ohne Abkündigungsfrist ändern. Sie ersetzt die Admin-API-Endpunkte unter /v1/organizations/tunnels, die während eines Migrationszeitraums weiterhin verfügbar bleiben.

Tunnel-Token rotieren
POST/v1/tunnels/{tunnel_id}/rotate_token

Die Tunnels API befindet sich in der "Research Preview" (Forschungsvorschau). Sie erfordert den Header anthropic-beta: mcp-tunnels-2026-06-22 und kann sich ohne Abkündigungsfrist ändern. Sie ersetzt die Admin-API-Endpunkte unter /v1/organizations/tunnels, die während eines Migrationszeitraums weiterhin verfügbar bleiben.

BetaTunnelZertifikate

Tunnel-Zertifikat erstellen
POST/v1/tunnels/{tunnel_id}/certificates

Die Tunnels API befindet sich in der "Research Preview" (Forschungsvorschau). Sie erfordert den Header anthropic-beta: mcp-tunnels-2026-06-22 und kann sich ohne Abkündigungsfrist ändern. Sie ersetzt die Admin-API-Endpunkte unter /v1/organizations/tunnels, die während eines Migrationszeitraums weiterhin verfügbar bleiben.

Tunnel-Zertifikat abrufen
GET/v1/tunnels/{tunnel_id}/certificates/{certificate_id}

Die Tunnels API befindet sich in der "Research Preview" (Forschungsvorschau). Sie erfordert den Header anthropic-beta: mcp-tunnels-2026-06-22 und kann sich ohne Abkündigungsfrist ändern. Sie ersetzt die Admin-API-Endpunkte unter /v1/organizations/tunnels, die während eines Migrationszeitraums weiterhin verfügbar bleiben.

Tunnel-Zertifikate auflisten
GET/v1/tunnels/{tunnel_id}/certificates

Die Tunnels API befindet sich in der "Research Preview" (Forschungsvorschau). Sie erfordert den Header anthropic-beta: mcp-tunnels-2026-06-22 und kann sich ohne Abkündigungsfrist ändern. Sie ersetzt die Admin-API-Endpunkte unter /v1/organizations/tunnels, die während eines Migrationszeitraums weiterhin verfügbar bleiben.

Tunnel-Zertifikat archivieren
POST/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

Die Tunnels API befindet sich in der "Research Preview" (Forschungsvorschau). Sie erfordert den Header anthropic-beta: mcp-tunnels-2026-06-22 und kann sich ohne Abkündigungsfrist ändern. Sie ersetzt die Admin-API-Endpunkte unter /v1/organizations/tunnels, die während eines Migrationszeitraums weiterhin verfügbar bleiben.

BetaOrganisation

Aktuelle Organisation abrufen
GET/v1/organizations/me

Ruft Informationen über die Organisation ab, die mit dem authentifizierten API-Key verknüpft ist.

BetaOrganisationAPI-Keys

API-Keys auflisten
GET/v1/organizations/api_keys
API-Key abrufen (Admin API)
GET/v1/organizations/api_keys/{api_key_id}

Ruft Informationen über einen einzelnen API-Key in deiner Organisation ab, nachgeschlagen anhand seiner ID. Dieser Admin-API-Endpunkt erfordert einen Admin-API-Key, ist für die programmatische Schlüsselverwaltung gedacht und gibt niemals den geheimen Wert des Keys zurück. Um deine eigenen API-Keys anzuzeigen oder zu erstellen, gehe zu API-Keys in der Claude Console.

API-Key aktualisieren
POST/v1/organizations/api_keys/{api_key_id}

BetaOrganisationExterne Schlüssel

Externen Schlüssel erstellen
POST/v1/organizations/external_keys

Erstellt eine externe Schlüsselkonfiguration, die der Organisation des Aufrufers gehört.

Externe Schlüssel auflisten
GET/v1/organizations/external_keys

Listet externe Schlüsselkonfigurationen in der Organisation des Aufrufers auf.

Externen Schlüssel abrufen
GET/v1/organizations/external_keys/{external_key_id}

Ruft eine einzelne externe Schlüsselkonfiguration in der Organisation des Aufrufers anhand ihrer ID ab.

Externen Schlüssel aktualisieren
POST/v1/organizations/external_keys/{external_key_id}

Aktualisiert eine externe Schlüsselkonfiguration teilweise. Ausgelassene Felder bleiben unverändert.

Externen Schlüssel löschen
DELETE/v1/organizations/external_keys/{external_key_id}

Löscht eine externe Schlüsselkonfiguration.

Externen Schlüssel validieren
POST/v1/organizations/external_keys/{external_key_id}/validate

Validiert eine externe Schlüsselkonfiguration gegen das KMS des Kunden.

BetaOrganisationFöderationIssuer

Federation-Issuer erstellen
POST/v1/organizations/federation_issuers

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Federation-Issuer auflisten
GET/v1/organizations/federation_issuers

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Federation-Issuer abrufen
GET/v1/organizations/federation_issuers/{federation_issuer_id}

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Federation-Issuer aktualisieren
POST/v1/organizations/federation_issuers/{federation_issuer_id}

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Federation-Issuer archivieren
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

BetaOrganisationFöderationRegeln

Federation-Regel erstellen
POST/v1/organizations/federation_rules

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Federation-Regeln auflisten
GET/v1/organizations/federation_rules

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Federation-Regel abrufen
GET/v1/organizations/federation_rules/{federation_rule_id}

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Federation-Regel aktualisieren
POST/v1/organizations/federation_rules/{federation_rule_id}

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Federation-Regel archivieren
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

BetaOrganisationFöderationRegelnWorkspaces

Workspace zu Federation-Regel hinzufügen
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Workspaces einer Federation-Regel auflisten
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Workspace aus Federation-Regel entfernen
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

BetaOrganisationEinladungen

Einladung erstellen
POST/v1/organizations/invites

Lädt einen Benutzer per E-Mail ein, der Organisation beizutreten.

Einladungen auflisten
GET/v1/organizations/invites

Listet die Einladungen der Organisation auf.

Einladung abrufen
GET/v1/organizations/invites/{invite_id}

Ruft eine Einladung anhand ihrer ID ab.

Einladung löschen
DELETE/v1/organizations/invites/{invite_id}

Löscht eine ausstehende Einladung.

BetaOrganisationService-Accounts

Service-Account erstellen
POST/v1/organizations/service_accounts

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Service-Accounts auflisten
GET/v1/organizations/service_accounts

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Service-Account abrufen
GET/v1/organizations/service_accounts/{service_account_id}

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Service-Account aktualisieren
POST/v1/organizations/service_accounts/{service_account_id}

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Service-Account archivieren
POST/v1/organizations/service_accounts/{service_account_id}/archive

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

BetaOrganisationService-AccountsWorkspaces

Workspace zu Service-Account hinzufügen
POST/v1/organizations/service_accounts/{service_account_id}/workspaces

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Workspaces für Service-Account auflisten
GET/v1/organizations/service_accounts/{service_account_id}/workspaces

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Workspace aus Service-Account entfernen
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

BetaOrganisationBenutzer

Benutzer auflisten
GET/v1/organizations/users

Listet die Mitglieder der Organisation auf.

Benutzer abrufen
GET/v1/organizations/users/{user_id}

Ruft ein Mitglied der Organisation anhand der Benutzer-ID ab.

Benutzer aktualisieren
POST/v1/organizations/users/{user_id}

Aktualisiert die Organisationsrolle eines Mitglieds.

Benutzer entfernen
DELETE/v1/organizations/users/{user_id}

Entfernt ein Mitglied aus der Organisation.

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

Listet die für einen Workspace konfigurierten Ratenlimit-Überschreibungen auf.

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

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Service-Account als Workspace-Mitglied erstellen
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

Erfordert ein OAuth-Zugriffstoken mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Service-Account als Workspace-Mitglied abrufen
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Erfordert ein OAuth-Zugriffstoken mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Service-Account als Workspace-Mitglied aktualisieren
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Erfordert ein OAuth-Zugriffstoken mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Service-Account als Workspace-Mitglied löschen
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Erfordert ein OAuth-Zugriffstoken mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

BetaOrganisationRatenlimits

Ratenlimits der Organisation auflisten
GET/v1/organizations/rate_limits

Liste die Messages-API-Ratenlimits (rate limits) für deine Organisation auf.

BetaOrganisationCompliance-Einstellungen

Compliance-Einstellungen abrufen
GET/v1/organizations/compliance_settings

Rufe die Compliance-Einstellungen deiner Organisation ab.

Compliance-Einstellungen aktualisieren
POST/v1/organizations/compliance_settings

Aktualisiere die Compliance-Einstellungen deiner Organisation.

BetaOrganisationNutzungsbericht

Messages-Nutzungsbericht abrufen
GET/v1/organizations/usage_report/messages
Claude Code-Nutzungsbericht abrufen
GET/v1/organizations/usage_report/claude_code

Ruft täglich aggregierte Nutzungsmetriken für Claude Code-Benutzer ab. Ermöglicht Organisationen, die Entwicklerproduktivität zu analysieren und eigene Dashboards zu erstellen.

BetaOrganisationKostenbericht

Kostenbericht abrufen
GET/v1/organizations/cost_report

BetaOrganisationMCP-Tunnel

Tunnels auflisten
Deprecated
GET/v1/organizations/tunnels

Abgekündigt. Dieser Admin API-Endpunkt wird durch /v1/tunnels in der Claude API ersetzt und nach einem Migrationszeitraum entfernt. Neue Integrationen sollten /v1/tunnels mit dem Header anthropic-beta: mcp-tunnels-2026-06-22 und einem WIF-Token mit dem Scope workspace:manage_tunnels verwenden. Bestehende Integrationen funktionieren während des Migrationszeitraums weiterhin mit dem Header mcp-tunnels-2026-05-19 und dem Scope org:manage_tunnels.

Tunnel abrufen
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}

Abgekündigt. Dieser Admin-API-Endpunkt wird durch /v1/tunnels in der Claude API ersetzt und nach einem Migrationszeitraum entfernt. Neue Integrationen sollten /v1/tunnels mit dem Header anthropic-beta: mcp-tunnels-2026-06-22 und einem WIF-Token mit dem Scope workspace:manage_tunnels verwenden. Bestehende Integrationen funktionieren während des Migrationszeitraums weiterhin mit dem Header mcp-tunnels-2026-05-19 und dem Scope org:manage_tunnels.

Tunnel archivieren
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/archive

Abgekündigt. Dieser Admin-API-Endpunkt wird durch /v1/tunnels in der Claude API ersetzt und nach einem Migrationszeitraum entfernt. Neue Integrationen sollten /v1/tunnels mit dem Header anthropic-beta: mcp-tunnels-2026-06-22 und einem WIF-Token mit dem Scope workspace:manage_tunnels verwenden. Bestehende Integrationen funktionieren während des Migrationszeitraums weiterhin mit dem Header mcp-tunnels-2026-05-19 und dem Scope org:manage_tunnels.

Tunnel-Token anzeigen
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/reveal_token

Abgekündigt. Dieser Admin API-Endpunkt wird durch /v1/tunnels in der Claude API ersetzt und nach einem Migrationszeitraum entfernt. Neue Integrationen sollten /v1/tunnels mit dem Header anthropic-beta: mcp-tunnels-2026-06-22 und einem WIF-Token mit dem Scope workspace:manage_tunnels verwenden. Bestehende Integrationen funktionieren während des Migrationszeitraums weiterhin mit dem Header mcp-tunnels-2026-05-19 und dem Scope org:manage_tunnels.

Tunnel-Token rotieren
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/rotate_token

Abgekündigt. Dieser Admin API-Endpunkt wird durch /v1/tunnels in der Claude API ersetzt und nach einem Migrationszeitraum entfernt. Neue Integrationen sollten /v1/tunnels mit dem Header anthropic-beta: mcp-tunnels-2026-06-22 und einem WIF-Token mit dem Scope workspace:manage_tunnels verwenden. Bestehende Integrationen funktionieren während des Migrationszeitraums weiterhin mit dem Header mcp-tunnels-2026-05-19 und dem Scope org:manage_tunnels.

BetaOrganisationMCP-TunnelTunnel-Zertifikate

Tunnel-Zertifikat erstellen
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates

Abgekündigt. Dieser Admin-API-Endpunkt wird durch /v1/tunnels in der Claude API ersetzt und nach einem Migrationszeitraum entfernt. Neue Integrationen sollten /v1/tunnels mit dem Header anthropic-beta: mcp-tunnels-2026-06-22 und einem WIF-Token mit dem Scope workspace:manage_tunnels verwenden. Bestehende Integrationen funktionieren während des Migrationszeitraums weiterhin mit dem Header mcp-tunnels-2026-05-19 und dem Scope org:manage_tunnels.

Tunnel-Zertifikate auflisten
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates

Abgekündigt. Dieser Admin API-Endpunkt wird durch /v1/tunnels in der Claude API ersetzt und nach einem Migrationszeitraum entfernt. Neue Integrationen sollten /v1/tunnels mit dem Header anthropic-beta: mcp-tunnels-2026-06-22 und einem WIF-Token mit dem Scope workspace:manage_tunnels verwenden. Bestehende Integrationen funktionieren während des Migrationszeitraums weiterhin mit dem Header mcp-tunnels-2026-05-19 und dem Scope org:manage_tunnels.

Tunnel-Zertifikat abrufen
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}

Abgekündigt. Dieser Admin-API-Endpunkt wird durch /v1/tunnels in der Claude API ersetzt und nach einem Migrationszeitraum entfernt. Neue Integrationen sollten /v1/tunnels mit dem Header anthropic-beta: mcp-tunnels-2026-06-22 und einem WIF-Token mit dem Scope workspace:manage_tunnels verwenden. Bestehende Integrationen funktionieren während des Migrationszeitraums weiterhin mit dem Header mcp-tunnels-2026-05-19 und dem Scope org:manage_tunnels.

Tunnel-Zertifikat archivieren
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

Abgekündigt. Dieser Admin-API-Endpunkt wird durch /v1/tunnels in der Claude API ersetzt und nach einem Migrationszeitraum entfernt. Neue Integrationen sollten /v1/tunnels mit dem Header anthropic-beta: mcp-tunnels-2026-06-22 und einem WIF-Token mit dem Scope workspace:manage_tunnels verwenden. Bestehende Integrationen funktionieren während des Migrationszeitraums weiterhin mit dem Header mcp-tunnels-2026-05-19 und dem Scope org:manage_tunnels.

BetaOrganisationAnalytics

Aktivitätszusammenfassungen abrufen
GET/v1/organizations/analytics/summaries

Ruft organisationsweite Aktivitätszusammenfassungen für einen Datumsbereich ab.

BetaOrganisationAnalyticsUsage

Token-Nutzung im Zeitverlauf abrufen
GET/v1/organizations/analytics/usage_report

Ruft die Token-Nutzung im Zeitverlauf über einen Datumsbereich ab.

Token-Nutzung pro Benutzer abrufen
GET/v1/organizations/analytics/user_usage_report

Ruft die Token-Nutzung pro Benutzer über einen Datumsbereich ab.

BetaOrganisationAnalyticsKosten

Kosten im Zeitverlauf abrufen
GET/v1/organizations/analytics/cost_report

Ruft die Kosten in USD im Zeitverlauf über einen Datumsbereich ab.

Kosten pro Benutzer abrufen
GET/v1/organizations/analytics/user_cost_report

Ruft die Kosten pro Benutzer in USD über einen Datumsbereich ab.

BetaOrganisationAnalyticsBenutzer

Benutzeraktivität auflisten
GET/v1/organizations/analytics/users

Ruft die Aktivität pro Benutzer für einen bestimmten Tag ab, mit Cursor-basierter Paginierung.

BetaOrganisationAnalyticsSkills

Skill-Nutzung abrufen
GET/v1/organizations/analytics/skills

Ruft die Nutzung pro Skill für einen bestimmten Tag ab, mit Cursor-basierter Paginierung.

BetaOrganisationAnalyticsKonnektoren

Konnektor-Nutzung abrufen
GET/v1/organizations/analytics/connectors

Ruft die Nutzung pro Konnektor für einen bestimmten Tag ab, mit Cursor-basierter Paginierung.

BetaOrganisationAnalyticsChat-Projekte

Chat-Projekt-Nutzung abrufen
GET/v1/organizations/analytics/apps/chat/projects

Ruft die Aktivität pro Projekt für einen bestimmten Tag ab, mit Cursor-basierter Paginierung.

BetaOrganisationAnalyticsPlugins

Plugin-Nutzung abrufen
GET/v1/organizations/analytics/plugins

Ruft die Installations- und Aufrufnutzung pro Plugin für einen bestimmten Tag ab, mit Paginierung.

BetaOrganisationAnalyticsArtifacts

Artifact-Aktivität abrufen
GET/v1/organizations/analytics/artifacts

Ruft die Aktivität zur Artifact-Erstellung für einen bestimmten Tag ab, aufgeschlüsselt nach MIME-Typ.

BetaOrganisationAusgabenlimits

Ausgabenlimit festlegen
POST/v1/organizations/spend_limits

Legt eine Ausgabenlimit-Überschreibung pro Benutzer fest.

Ausgabenlimit abrufen
GET/v1/organizations/spend_limits/{spend_limit_id}

Ruft ein Ausgabenlimit anhand seiner ID ab.

Ausgabenlimit löschen
DELETE/v1/organizations/spend_limits/{spend_limit_id}

Löscht eine Ausgabenlimit-Überschreibung pro Benutzer.

Effektive Ausgabenlimits auflisten
GET/v1/organizations/spend_limits/effective

Listet das effektive Ausgabenlimit und die bisherigen Ausgaben im Zeitraum für jedes Mitglied auf.

BetaOrganisationAusgabenlimitsErhöhungsanfragen

Anfragen zur Erhöhung des Ausgabenlimits auflisten
GET/v1/organizations/spend_limit_increase_requests

Listet Anfragen zur Erhöhung des Ausgabenlimits auf, neueste zuerst.

Anfrage zur Erhöhung des Ausgabenlimits abrufen
GET/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}

Ruft eine Anfrage zur Erhöhung des Ausgabenlimits ab.

Anfrage zur Erhöhung des Ausgabenlimits genehmigen
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve

Genehmigt eine ausstehende Anfrage zur Erhöhung des Ausgabenlimits.

Anfrage zur Erhöhung des Ausgabenlimits ablehnen
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny

Lehnt eine ausstehende Anfrage zur Erhöhung des Ausgabenlimits ab.

BetaOrganisationRBAC-Gruppen

RBAC-Gruppen auflisten
GET/v1/organizations/rbac_groups

Listet RBAC-Gruppen im Claude Enterprise-Tenant auf.

RBAC-Gruppe abrufen
GET/v1/organizations/rbac_groups/{group_id}

Ruft eine RBAC-Gruppe anhand ihrer ID ab.

RBAC-Gruppe erstellen
POST/v1/organizations/rbac_groups

Erstellt eine RBAC-Gruppe im Claude Enterprise-Tenant. Über die API erstellte Gruppen haben den Quelltyp "direct".

RBAC-Gruppe aktualisieren
POST/v1/organizations/rbac_groups/{group_id}

Aktualisiert den Namen einer RBAC-Gruppe. Von einem Identitätsanbieter bereitgestellte Gruppen (Quelltyp "scim") können nicht über die API geändert werden, solange eine Organisation im Tenant SCIM-Provisionierung verwendet.

RBAC-Gruppe löschen
DELETE/v1/organizations/rbac_groups/{group_id}

Löscht eine RBAC-Gruppe. Von einem Identitätsanbieter bereitgestellte Gruppen (Quelltyp "scim") können nicht über die API gelöscht werden, solange eine Organisation im Tenant SCIM-Provisionierung verwendet.

BetaOrganisationRBAC-GruppenMitglieder

Mitglieder einer RBAC-Gruppe auflisten
GET/v1/organizations/rbac_groups/{group_id}/members

Listet die Mitglieder einer RBAC-Gruppe auf.

Mitglied zu RBAC-Gruppe hinzufügen
POST/v1/organizations/rbac_groups/{group_id}/members

Fügt einen Benutzer zu einer RBAC-Gruppe hinzu. Die Mitgliedschaft in Gruppen, die von einem Identitätsanbieter bereitgestellt werden (Quelltyp "scim"), kann nicht über die API geändert werden, solange eine Organisation im Tenant SCIM-Provisionierung verwendet.

Mitglied aus RBAC-Gruppe entfernen
DELETE/v1/organizations/rbac_groups/{group_id}/members/{user_id}

Entfernt einen Benutzer aus einer RBAC-Gruppe. Die Mitgliedschaft in Gruppen, die von einem Identitätsanbieter bereitgestellt werden (Quelltyp "scim"), kann nicht über die API geändert werden, solange eine Organisation im Tenant SCIM-Provisionierung verwendet.

BetaOrganisationRBAC-Rollen

RBAC-Rollen auflisten
GET/v1/organizations/rbac_roles

Listet RBAC-Rollen in der Organisation auf.

RBAC-Rolle abrufen
GET/v1/organizations/rbac_roles/{role_id}

Ruft eine RBAC-Rolle anhand ihrer ID ab.

BetaOrganisationRBAC-RollenBerechtigungen

Berechtigungen einer RBAC-Rolle auflisten
GET/v1/organizations/rbac_roles/{role_id}/permissions

Listet die Berechtigungen auf, die eine RBAC-Rolle gewährt.