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

BetaModel

Daftar Model
GET/v1/models
Dapatkan Model
GET/v1/models/{model_id}

BetaPesan

Buat Message
POST/v1/messages
Hitung token dalam Message
POST/v1/messages/count_tokens

BetaPesanBatch

Buat Message Batch
POST/v1/messages/batches
Ambil Message Batch
GET/v1/messages/batches/{message_batch_id}
Daftar Message Batch
GET/v1/messages/batches
Batalkan Message Batch
POST/v1/messages/batches/{message_batch_id}/cancel
Hapus Message Batch
DELETE/v1/messages/batches/{message_batch_id}
Ambil hasil Message Batch
GET/v1/messages/batches/{message_batch_id}/results

BetaAgen

Buat Agen
POST/v1/agents
Daftar Agen
GET/v1/agents
Dapatkan Agen
GET/v1/agents/{agent_id}
Perbarui Agen
POST/v1/agents/{agent_id}
Arsipkan Agen
POST/v1/agents/{agent_id}/archive

BetaAgenVersi

Daftar Versi Agen
GET/v1/agents/{agent_id}/versions

BetaEnvironment

Buat Environment
POST/v1/environments
Daftar Environment
GET/v1/environments
Dapatkan Environment
GET/v1/environments/{environment_id}
Perbarui Environment
POST/v1/environments/{environment_id}
Hapus Environment
DELETE/v1/environments/{environment_id}
Arsipkan Environment
POST/v1/environments/{environment_id}/archive

BetaEnvironmentPekerjaan

Dapatkan Item Pekerjaan
GET/v1/environments/{environment_id}/work/{work_id}
Poll untuk Pekerjaan
GET/v1/environments/{environment_id}/work/poll
Konfirmasi Pekerjaan
POST/v1/environments/{environment_id}/work/{work_id}/ack
Catat Heartbeat
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat
Hentikan Pekerjaan
POST/v1/environments/{environment_id}/work/{work_id}/stop
Daftar Item Pekerjaan
GET/v1/environments/{environment_id}/work
Perbarui Item Pekerjaan
POST/v1/environments/{environment_id}/work/{work_id}
Dapatkan Statistik Antrean
GET/v1/environments/{environment_id}/work/stats

BetaSesi

Buat Sesi
POST/v1/sessions
Daftar Sesi
GET/v1/sessions
Dapatkan Sesi
GET/v1/sessions/{session_id}
Perbarui Sesi
POST/v1/sessions/{session_id}
Hapus Sesi
DELETE/v1/sessions/{session_id}
Arsipkan Sesi
POST/v1/sessions/{session_id}/archive

BetaSesiEvent

Daftar Event
GET/v1/sessions/{session_id}/events
Kirim Event
POST/v1/sessions/{session_id}/events
Stream Event
GET/v1/sessions/{session_id}/events/stream

BetaSesiResource

Tambah Resource Sesi
POST/v1/sessions/{session_id}/resources
Daftar Resource Sesi
GET/v1/sessions/{session_id}/resources
Dapatkan Resource Sesi
GET/v1/sessions/{session_id}/resources/{resource_id}
Perbarui Resource Sesi
POST/v1/sessions/{session_id}/resources/{resource_id}
Hapus Resource Sesi
DELETE/v1/sessions/{session_id}/resources/{resource_id}

BetaSesiThread

Daftar Thread Sesi
GET/v1/sessions/{session_id}/threads
Dapatkan Thread Sesi
GET/v1/sessions/{session_id}/threads/{thread_id}
Arsipkan Thread Sesi
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

BetaSesiThreadEvent

Daftar Event Thread Sesi
GET/v1/sessions/{session_id}/threads/{thread_id}/events
Stream Event Thread Sesi
GET/v1/sessions/{session_id}/threads/{thread_id}/stream

BetaDeployment

Buat Deployment
POST/v1/deployments
Daftar Deployment
GET/v1/deployments
Dapatkan Deployment
GET/v1/deployments/{deployment_id}
Perbarui Deployment
POST/v1/deployments/{deployment_id}
Arsipkan Deployment
POST/v1/deployments/{deployment_id}/archive
Jalankan Deployment Sekarang
POST/v1/deployments/{deployment_id}/run
Jeda Deployment
POST/v1/deployments/{deployment_id}/pause
Lanjutkan Deployment
POST/v1/deployments/{deployment_id}/unpause

BetaEksekusi Deployment

Daftar Eksekusi Deployment
GET/v1/deployment_runs
Dapatkan Eksekusi Deployment
GET/v1/deployment_runs/{deployment_run_id}

BetaVault

Buat Vault
POST/v1/vaults
Daftar Vault
GET/v1/vaults
Dapatkan Vault
GET/v1/vaults/{vault_id}
Perbarui Vault
POST/v1/vaults/{vault_id}
Hapus Vault
DELETE/v1/vaults/{vault_id}
Arsipkan Vault
POST/v1/vaults/{vault_id}/archive

BetaVaultKredensial

Buat Kredensial
POST/v1/vaults/{vault_id}/credentials
Daftar Kredensial
GET/v1/vaults/{vault_id}/credentials
Dapatkan Kredensial
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Perbarui Kredensial
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Hapus Kredensial
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Arsipkan Kredensial
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Validasi Kredensial
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate

BetaMemory Store

Buat memory store
POST/v1/memory_stores
Daftar memory store
GET/v1/memory_stores
Ambil memory store
GET/v1/memory_stores/{memory_store_id}
Perbarui memory store
POST/v1/memory_stores/{memory_store_id}
Hapus memory store
DELETE/v1/memory_stores/{memory_store_id}
Arsipkan memory store
POST/v1/memory_stores/{memory_store_id}/archive

BetaMemory StoreMemori

Buat memori
POST/v1/memory_stores/{memory_store_id}/memories
Daftar memori
GET/v1/memory_stores/{memory_store_id}/memories
Ambil memori
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Perbarui memori
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Hapus memori
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}

BetaMemory StoreVersi Memori

Daftar versi memori
GET/v1/memory_stores/{memory_store_id}/memory_versions
Ambil versi memori
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
Redaksi versi memori
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

BetaFile

Unggah File
POST/v1/files
Daftar File
GET/v1/files
Unduh File
GET/v1/files/{file_id}/content
Dapatkan Metadata File
GET/v1/files/{file_id}
Hapus File
DELETE/v1/files/{file_id}

BetaSkill

Buat Skill
POST/v1/skills
Daftar Skill
GET/v1/skills
Dapatkan Skill
GET/v1/skills/{skill_id}
Hapus Skill
DELETE/v1/skills/{skill_id}

BetaSkillVersi

Buat Versi Skill
POST/v1/skills/{skill_id}/versions
Daftar Versi Skill
GET/v1/skills/{skill_id}/versions
Unduh Konten Versi Skill
GET/v1/skills/{skill_id}/versions/{version}/content
Dapatkan Versi Skill
GET/v1/skills/{skill_id}/versions/{version}
Hapus Versi Skill
DELETE/v1/skills/{skill_id}/versions/{version}

BetaWebhook

Unwrap
Function
Parse Unverified
Function

BetaProfil Pengguna

Buat Profil Pengguna
POST/v1/user_profiles
Daftar Profil Pengguna
GET/v1/user_profiles
Dapatkan Profil Pengguna
GET/v1/user_profiles/{user_profile_id}
Perbarui Profil Pengguna
POST/v1/user_profiles/{user_profile_id}
Buat URL Pendaftaran
POST/v1/user_profiles/{user_profile_id}/enrollment_url

BetaDream

Buat Dream
POST/v1/dreams
Daftar Dream
GET/v1/dreams
Dapatkan Dream
GET/v1/dreams/{dream_id}
Batalkan Dream
POST/v1/dreams/{dream_id}/cancel
Arsipkan Dream
POST/v1/dreams/{dream_id}/archive

BetaTunnel

Buat Tunnel
POST/v1/tunnels
Dapatkan Tunnel
GET/v1/tunnels/{tunnel_id}
Daftar Tunnel
GET/v1/tunnels
Arsipkan Tunnel
POST/v1/tunnels/{tunnel_id}/archive
Tampilkan Token Tunnel
POST/v1/tunnels/{tunnel_id}/reveal_token
Rotasi Token Tunnel
POST/v1/tunnels/{tunnel_id}/rotate_token

BetaTunnelSertifikat

Buat Sertifikat Tunnel
POST/v1/tunnels/{tunnel_id}/certificates
Dapatkan Sertifikat Tunnel
GET/v1/tunnels/{tunnel_id}/certificates/{certificate_id}
Daftar Sertifikat Tunnel
GET/v1/tunnels/{tunnel_id}/certificates
Arsipkan Sertifikat Tunnel
POST/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

BetaOrganisasi

Dapatkan Organisasi Saat Ini
GET/v1/organizations/me

BetaOrganisasiKunci API

Daftar Kunci API
GET/v1/organizations/api_keys
Ambil Kunci API
GET/v1/organizations/api_keys/{api_key_id}
Perbarui Kunci API
POST/v1/organizations/api_keys/{api_key_id}

BetaOrganisasiKunci Eksternal

Buat Kunci Eksternal
POST/v1/organizations/external_keys
Daftar Kunci Eksternal
GET/v1/organizations/external_keys
Dapatkan Kunci Eksternal
GET/v1/organizations/external_keys/{external_key_id}
Perbarui Kunci Eksternal
POST/v1/organizations/external_keys/{external_key_id}
Hapus Kunci Eksternal
DELETE/v1/organizations/external_keys/{external_key_id}
Validasi Kunci Eksternal
POST/v1/organizations/external_keys/{external_key_id}/validate

BetaOrganisasiFederasiPenerbit

Buat Issuer Federasi
POST/v1/organizations/federation_issuers
Daftar Issuer Federasi
GET/v1/organizations/federation_issuers
Dapatkan Issuer Federasi
GET/v1/organizations/federation_issuers/{federation_issuer_id}
Perbarui Issuer Federasi
POST/v1/organizations/federation_issuers/{federation_issuer_id}
Arsipkan Issuer Federasi
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

BetaOrganisasiFederasiAturan

Buat Aturan Federasi
POST/v1/organizations/federation_rules
Daftar Aturan Federasi
GET/v1/organizations/federation_rules
Dapatkan Aturan Federasi
GET/v1/organizations/federation_rules/{federation_rule_id}
Perbarui Aturan Federasi
POST/v1/organizations/federation_rules/{federation_rule_id}
Arsipkan Aturan Federasi
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

BetaOrganisasiFederasiAturanWorkspace

Tambahkan Workspace Aturan Federasi
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Daftar Workspace Aturan Federasi
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Hapus Workspace Aturan Federasi
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

BetaOrganisasiUndangan

Buat Undangan
POST/v1/organizations/invites
Daftar Undangan
GET/v1/organizations/invites
Dapatkan Undangan
GET/v1/organizations/invites/{invite_id}
Hapus Undangan
DELETE/v1/organizations/invites/{invite_id}

BetaOrganisasiAkun Layanan

Buat Akun Layanan
POST/v1/organizations/service_accounts
Daftar Akun Layanan
GET/v1/organizations/service_accounts
Dapatkan Akun Layanan
GET/v1/organizations/service_accounts/{service_account_id}
Perbarui Akun Layanan
POST/v1/organizations/service_accounts/{service_account_id}
Arsipkan Akun Layanan
POST/v1/organizations/service_accounts/{service_account_id}/archive

BetaOrganisasiAkun LayananWorkspace

Tambahkan Workspace ke Akun Layanan
POST/v1/organizations/service_accounts/{service_account_id}/workspaces
Daftar Workspace untuk Akun Layanan
GET/v1/organizations/service_accounts/{service_account_id}/workspaces
Hapus Workspace dari Akun Layanan
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

BetaOrganisasiPengguna

Daftar Pengguna
GET/v1/organizations/users
Dapatkan Pengguna
GET/v1/organizations/users/{user_id}
Perbarui Pengguna
POST/v1/organizations/users/{user_id}
Hapus Pengguna
DELETE/v1/organizations/users/{user_id}

BetaOrganisasiWorkspace

Daftar Workspace
GET/v1/organizations/workspaces
Buat Workspace
POST/v1/organizations/workspaces
Dapatkan Workspace
GET/v1/organizations/workspaces/{workspace_id}
Perbarui Workspace
POST/v1/organizations/workspaces/{workspace_id}
Arsipkan Workspace
POST/v1/organizations/workspaces/{workspace_id}/archive

BetaOrganisasiWorkspaceBatas Laju

Daftar Batas Laju Workspace
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

BetaOrganisasiWorkspaceAnggota

Daftar Anggota Workspace
GET/v1/organizations/workspaces/{workspace_id}/members
Buat Anggota Workspace
POST/v1/organizations/workspaces/{workspace_id}/members
Dapatkan Anggota Workspace
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Perbarui Anggota Workspace
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Hapus Anggota Workspace
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

BetaOrganisasiWorkspaceAkun Layanan

Daftar Anggota Workspace Akun Layanan
GET/v1/organizations/workspaces/{workspace_id}/service_accounts
Buat Anggota Workspace Akun Layanan
POST/v1/organizations/workspaces/{workspace_id}/service_accounts
Dapatkan Anggota Workspace Akun Layanan
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Perbarui Anggota Workspace Akun Layanan
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Hapus Anggota Workspace Akun Layanan
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

BetaOrganisasiBatas Laju

Daftar Batas Laju Organisasi
GET/v1/organizations/rate_limits

BetaOrganisasiPengaturan Kepatuhan

Mendapatkan Pengaturan Kepatuhan
GET/v1/organizations/compliance_settings
Memperbarui Pengaturan Kepatuhan
POST/v1/organizations/compliance_settings