Claude Platform Docs

Beta

Models
enum AnthropicBeta:
class BetaApiError:
String message
JsonValue type "api_error"constant
class BetaAuthenticationError:
String message
JsonValue type "authentication_error"constant
class BetaBillingError:
String message
JsonValue type "billing_error"constant
enum BetaCurrency:
USD("USD")
class BetaError: A class that can be one of several variants.union
class BetaErrorResponse:
BetaError error
One of the following:
Optional<String> requestId
JsonValue type "error"constant
class BetaGatewayTimeoutError:
String message
JsonValue type "timeout_error"constant
class BetaInvalidRequestError:
String message
JsonValue type "invalid_request_error"constant
class BetaMonetaryAmount:

A monetary amount in a specific currency.

String amount

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.

BetaCurrency currency

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.

class BetaNotFoundError:
String message
JsonValue type "not_found_error"constant
class BetaOverloadedError:
String message
JsonValue type "overloaded_error"constant
class BetaPermissionError:
String message
JsonValue type "permission_error"constant
class BetaRateLimitError:
String message
JsonValue type "rate_limit_error"constant

BetaModels

List Models
ModelListPage beta().models().list(ModelListParamsparams = ModelListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/models
Get a Model
BetaModelInfo beta().models().retrieve(ModelRetrieveParamsparams = ModelRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/models/{model_id}

BetaMessages

Create a Message
BetaMessage beta().messages().create(MessageCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/messages
Count tokens in a Message
BetaMessageTokensCount beta().messages().countTokens(MessageCountTokensParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/messages/count_tokens

BetaMessagesBatches

Create a Message Batch
BetaMessageBatch beta().messages().batches().create(BatchCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/messages/batches
Retrieve a Message Batch
BetaMessageBatch beta().messages().batches().retrieve(BatchRetrieveParamsparams = BatchRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/messages/batches/{message_batch_id}
List Message Batches
BatchListPage beta().messages().batches().list(BatchListParamsparams = BatchListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/messages/batches
Cancel a Message Batch
BetaMessageBatch beta().messages().batches().cancel(BatchCancelParamsparams = BatchCancelParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/messages/batches/{message_batch_id}/cancel
Delete a Message Batch
BetaDeletedMessageBatch beta().messages().batches().delete(BatchDeleteParamsparams = BatchDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/v1/messages/batches/{message_batch_id}
Retrieve Message Batch results
BetaMessageBatchIndividualResponse beta().messages().batches().resultsStreaming(BatchResultsParamsparams = BatchResultsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/messages/batches/{message_batch_id}/results

BetaAgents

Create Agent
BetaManagedAgentsAgent beta().agents().create(AgentCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/agents
List Agents
AgentListPage beta().agents().list(AgentListParamsparams = AgentListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/agents
Get Agent
BetaManagedAgentsAgent beta().agents().retrieve(AgentRetrieveParamsparams = AgentRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/agents/{agent_id}
Update Agent
BetaManagedAgentsAgent beta().agents().update(AgentUpdateParamsparams = AgentUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/agents/{agent_id}
Archive Agent
BetaManagedAgentsAgent beta().agents().archive(AgentArchiveParamsparams = AgentArchiveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/agents/{agent_id}/archive

BetaAgentsVersions

List Agent Versions
VersionListPage beta().agents().versions().list(VersionListParamsparams = VersionListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/agents/{agent_id}/versions

BetaEnvironments

Create Environment
BetaEnvironment beta().environments().create(EnvironmentCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/environments
List Environments
EnvironmentListPage beta().environments().list(EnvironmentListParamsparams = EnvironmentListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/environments
Get Environment
BetaEnvironment beta().environments().retrieve(EnvironmentRetrieveParamsparams = EnvironmentRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/environments/{environment_id}
Update Environment
BetaEnvironment beta().environments().update(EnvironmentUpdateParamsparams = EnvironmentUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/environments/{environment_id}
Delete Environment
BetaEnvironmentDeleteResponse beta().environments().delete(EnvironmentDeleteParamsparams = EnvironmentDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/v1/environments/{environment_id}
Archive Environment
BetaEnvironment beta().environments().archive(EnvironmentArchiveParamsparams = EnvironmentArchiveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/environments/{environment_id}/archive

BetaEnvironmentsWork

Get Work Item
BetaSelfHostedWork beta().environments().work().retrieve(WorkRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/environments/{environment_id}/work/{work_id}
Poll for Work
BetaSelfHostedWork beta().environments().work().poll(WorkPollParamsparams = WorkPollParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/environments/{environment_id}/work/poll
Acknowledge Work
BetaSelfHostedWork beta().environments().work().ack(WorkAckParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/environments/{environment_id}/work/{work_id}/ack
Record Heartbeat
BetaSelfHostedWorkHeartbeatResponse beta().environments().work().heartbeat(WorkHeartbeatParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat
Stop Work
BetaSelfHostedWork beta().environments().work().stop(WorkStopParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/environments/{environment_id}/work/{work_id}/stop
List Work Items
WorkListPage beta().environments().work().list(WorkListParamsparams = WorkListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/environments/{environment_id}/work
Update Work Item
BetaSelfHostedWork beta().environments().work().update(WorkUpdateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/environments/{environment_id}/work/{work_id}
Get Queue Statistics
BetaSelfHostedWorkQueueStats beta().environments().work().stats(WorkStatsParamsparams = WorkStatsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/environments/{environment_id}/work/stats

BetaSessions

Create Session
BetaManagedAgentsSession beta().sessions().create(SessionCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/sessions
List Sessions
SessionListPage beta().sessions().list(SessionListParamsparams = SessionListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/sessions
Get Session
BetaManagedAgentsSession beta().sessions().retrieve(SessionRetrieveParamsparams = SessionRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}
Update Session
BetaManagedAgentsSession beta().sessions().update(SessionUpdateParamsparams = SessionUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/sessions/{session_id}
Delete Session
BetaManagedAgentsDeletedSession beta().sessions().delete(SessionDeleteParamsparams = SessionDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/v1/sessions/{session_id}
Archive Session
BetaManagedAgentsSession beta().sessions().archive(SessionArchiveParamsparams = SessionArchiveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/sessions/{session_id}/archive

BetaSessionsEvents

List Events
EventListPage beta().sessions().events().list(EventListParamsparams = EventListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/events
Send Events
BetaManagedAgentsSendSessionEvents beta().sessions().events().send(EventSendParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/sessions/{session_id}/events
Stream Events
BetaManagedAgentsStreamSessionEvents beta().sessions().events().streamStreaming(EventStreamParamsparams = EventStreamParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/events/stream

BetaSessionsResources

Add Session Resource
BetaManagedAgentsFileResource beta().sessions().resources().add(ResourceAddParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/sessions/{session_id}/resources
List Session Resources
ResourceListPage beta().sessions().resources().list(ResourceListParamsparams = ResourceListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/resources
Get Session Resource
ResourceRetrieveResponse beta().sessions().resources().retrieve(ResourceRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/resources/{resource_id}
Update Session Resource
ResourceUpdateResponse beta().sessions().resources().update(ResourceUpdateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/sessions/{session_id}/resources/{resource_id}
Delete Session Resource
BetaManagedAgentsDeleteSessionResource beta().sessions().resources().delete(ResourceDeleteParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
DELETE/v1/sessions/{session_id}/resources/{resource_id}

BetaSessionsThreads

List Session Threads
ThreadListPage beta().sessions().threads().list(ThreadListParamsparams = ThreadListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/threads
Get Session Thread
BetaManagedAgentsSessionThread beta().sessions().threads().retrieve(ThreadRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/threads/{thread_id}
Archive Session Thread
BetaManagedAgentsSessionThread beta().sessions().threads().archive(ThreadArchiveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

BetaSessionsThreadsEvents

List Session Thread Events
EventListPage beta().sessions().threads().events().list(EventListParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/threads/{thread_id}/events
Stream Session Thread Events
BetaManagedAgentsStreamSessionThreadEvents beta().sessions().threads().events().streamStreaming(EventStreamParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/threads/{thread_id}/stream

BetaDeployments

Create Deployment
BetaManagedAgentsDeployment beta().deployments().create(DeploymentCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/deployments
List Deployments
DeploymentListPage beta().deployments().list(DeploymentListParamsparams = DeploymentListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/deployments
Get Deployment
BetaManagedAgentsDeployment beta().deployments().retrieve(DeploymentRetrieveParamsparams = DeploymentRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/deployments/{deployment_id}
Update Deployment
BetaManagedAgentsDeployment beta().deployments().update(DeploymentUpdateParamsparams = DeploymentUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/deployments/{deployment_id}
Archive Deployment
BetaManagedAgentsDeployment beta().deployments().archive(DeploymentArchiveParamsparams = DeploymentArchiveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/deployments/{deployment_id}/archive
Run Deployment Now
BetaManagedAgentsDeploymentRun beta().deployments().run(DeploymentRunParamsparams = DeploymentRunParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/deployments/{deployment_id}/run
Pause Deployment
BetaManagedAgentsDeployment beta().deployments().pause(DeploymentPauseParamsparams = DeploymentPauseParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/deployments/{deployment_id}/pause
Unpause Deployment
BetaManagedAgentsDeployment beta().deployments().unpause(DeploymentUnpauseParamsparams = DeploymentUnpauseParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/deployments/{deployment_id}/unpause

BetaDeployment Runs

List Deployment Runs
DeploymentRunListPage beta().deploymentRuns().list(DeploymentRunListParamsparams = DeploymentRunListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/deployment_runs
Get Deployment Run
BetaManagedAgentsDeploymentRun beta().deploymentRuns().retrieve(DeploymentRunRetrieveParamsparams = DeploymentRunRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/deployment_runs/{deployment_run_id}

BetaVaults

Create Vault
BetaManagedAgentsVault beta().vaults().create(VaultCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/vaults
List Vaults
VaultListPage beta().vaults().list(VaultListParamsparams = VaultListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/vaults
Get Vault
BetaManagedAgentsVault beta().vaults().retrieve(VaultRetrieveParamsparams = VaultRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/vaults/{vault_id}
Update Vault
BetaManagedAgentsVault beta().vaults().update(VaultUpdateParamsparams = VaultUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/vaults/{vault_id}
Delete Vault
BetaManagedAgentsDeletedVault beta().vaults().delete(VaultDeleteParamsparams = VaultDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/v1/vaults/{vault_id}
Archive Vault
BetaManagedAgentsVault beta().vaults().archive(VaultArchiveParamsparams = VaultArchiveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/vaults/{vault_id}/archive

BetaVaultsCredentials

Create Credential
BetaManagedAgentsCredential beta().vaults().credentials().create(CredentialCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/vaults/{vault_id}/credentials
List Credentials
CredentialListPage beta().vaults().credentials().list(CredentialListParamsparams = CredentialListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/vaults/{vault_id}/credentials
Get Credential
BetaManagedAgentsCredential beta().vaults().credentials().retrieve(CredentialRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Update Credential
BetaManagedAgentsCredential beta().vaults().credentials().update(CredentialUpdateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Delete Credential
BetaManagedAgentsDeletedCredential beta().vaults().credentials().delete(CredentialDeleteParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Archive Credential
BetaManagedAgentsCredential beta().vaults().credentials().archive(CredentialArchiveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Validate Credential
BetaManagedAgentsCredentialValidation beta().vaults().credentials().mcpOAuthValidate(CredentialMcpOAuthValidateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate

BetaMemory Stores

Create a memory store
BetaManagedAgentsMemoryStore beta().memoryStores().create(MemoryStoreCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/memory_stores
List memory stores
MemoryStoreListPage beta().memoryStores().list(MemoryStoreListParamsparams = MemoryStoreListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/memory_stores
Retrieve a memory store
BetaManagedAgentsMemoryStore beta().memoryStores().retrieve(MemoryStoreRetrieveParamsparams = MemoryStoreRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/memory_stores/{memory_store_id}
Update a memory store
BetaManagedAgentsMemoryStore beta().memoryStores().update(MemoryStoreUpdateParamsparams = MemoryStoreUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/memory_stores/{memory_store_id}
Delete a memory store
BetaManagedAgentsDeletedMemoryStore beta().memoryStores().delete(MemoryStoreDeleteParamsparams = MemoryStoreDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/v1/memory_stores/{memory_store_id}
Archive a memory store
BetaManagedAgentsMemoryStore beta().memoryStores().archive(MemoryStoreArchiveParamsparams = MemoryStoreArchiveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/memory_stores/{memory_store_id}/archive

BetaMemory StoresMemories

Create a memory
BetaManagedAgentsMemory beta().memoryStores().memories().create(MemoryCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/memory_stores/{memory_store_id}/memories
List memories
MemoryListPage beta().memoryStores().memories().list(MemoryListParamsparams = MemoryListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/memory_stores/{memory_store_id}/memories
Retrieve a memory
BetaManagedAgentsMemory beta().memoryStores().memories().retrieve(MemoryRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Update a memory
BetaManagedAgentsMemory beta().memoryStores().memories().update(MemoryUpdateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Delete a memory
BetaManagedAgentsDeletedMemory beta().memoryStores().memories().delete(MemoryDeleteParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}

BetaMemory StoresMemory Versions

List memory versions
MemoryVersionListPage beta().memoryStores().memoryVersions().list(MemoryVersionListParamsparams = MemoryVersionListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/memory_stores/{memory_store_id}/memory_versions
Retrieve a memory version
BetaManagedAgentsMemoryVersion beta().memoryStores().memoryVersions().retrieve(MemoryVersionRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
Redact a memory version
BetaManagedAgentsMemoryVersion beta().memoryStores().memoryVersions().redact(MemoryVersionRedactParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

BetaFiles

Upload File
BetaFileMetadata beta().files().upload(FileUploadParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/files
List Files
FileListPage beta().files().list(FileListParamsparams = FileListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/files
Download File
HttpResponse beta().files().download(FileDownloadParamsparams = FileDownloadParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/files/{file_id}/content
Get File Metadata
BetaFileMetadata beta().files().retrieveMetadata(FileRetrieveMetadataParamsparams = FileRetrieveMetadataParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/files/{file_id}
Delete File
BetaDeletedFile beta().files().delete(FileDeleteParamsparams = FileDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/v1/files/{file_id}

BetaSkills

Create Skill
BetaSkill beta().skills().create(SkillCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/skills
List Skills
SkillListPage beta().skills().list(SkillListParamsparams = SkillListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/skills
Get Skill
BetaSkill beta().skills().retrieve(SkillRetrieveParamsparams = SkillRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/skills/{skill_id}
Delete Skill
BetaDeletedSkill beta().skills().delete(SkillDeleteParamsparams = SkillDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/v1/skills/{skill_id}

BetaSkillsVersions

Create Skill Version
BetaSkillVersion beta().skills().versions().create(VersionCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/skills/{skill_id}/versions
List Skill Versions
VersionListPage beta().skills().versions().list(VersionListParamsparams = VersionListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/skills/{skill_id}/versions
Download Skill Version Content
HttpResponse beta().skills().versions().download(VersionDownloadParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/skills/{skill_id}/versions/{version}/content
Get Skill Version
BetaSkillVersion beta().skills().versions().retrieve(VersionRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/skills/{skill_id}/versions/{version}
Delete Skill Version
BetaDeletedSkillVersion beta().skills().versions().delete(VersionDeleteParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
DELETE/v1/skills/{skill_id}/versions/{version}

BetaUser Profiles

Create User Profile
BetaUserProfile beta().userProfiles().create(UserProfileCreateParamsparams = UserProfileCreateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/user_profiles
List User Profiles
UserProfileListPage beta().userProfiles().list(UserProfileListParamsparams = UserProfileListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/user_profiles
Get User Profile
BetaUserProfile beta().userProfiles().retrieve(UserProfileRetrieveParamsparams = UserProfileRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/user_profiles/{user_profile_id}
Update User Profile
BetaUserProfile beta().userProfiles().update(UserProfileUpdateParamsparams = UserProfileUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/user_profiles/{user_profile_id}
Create Enrollment URL
BetaUserProfileEnrollmentUrl beta().userProfiles().createEnrollmentUrl(UserProfileCreateEnrollmentUrlParamsparams = UserProfileCreateEnrollmentUrlParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/user_profiles/{user_profile_id}/enrollment_url

BetaDreams

Create a Dream
BetaDream beta().dreams().create(DreamCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/dreams
List Dreams
DreamListPage beta().dreams().list(DreamListParamsparams = DreamListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/dreams
Get a Dream
BetaDream beta().dreams().retrieve(DreamRetrieveParamsparams = DreamRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/dreams/{dream_id}
Cancel a Dream
BetaDream beta().dreams().cancel(DreamCancelParamsparams = DreamCancelParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/dreams/{dream_id}/cancel
Archive a Dream
BetaDream beta().dreams().archive(DreamArchiveParamsparams = DreamArchiveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/dreams/{dream_id}/archive

BetaTunnels

Create Tunnel
BetaTunnel beta().tunnels().create(TunnelCreateParamsparams = TunnelCreateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/tunnels
Get Tunnel
BetaTunnel beta().tunnels().retrieve(TunnelRetrieveParamsparams = TunnelRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/tunnels/{tunnel_id}
List Tunnels
TunnelListPage beta().tunnels().list(TunnelListParamsparams = TunnelListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/tunnels
Archive Tunnel
BetaTunnel beta().tunnels().archive(TunnelArchiveParamsparams = TunnelArchiveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/tunnels/{tunnel_id}/archive
Reveal Tunnel Token
BetaTunnelToken beta().tunnels().revealToken(TunnelRevealTokenParamsparams = TunnelRevealTokenParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/tunnels/{tunnel_id}/reveal_token
Rotate Tunnel Token
BetaTunnelToken beta().tunnels().rotateToken(TunnelRotateTokenParamsparams = TunnelRotateTokenParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/tunnels/{tunnel_id}/rotate_token

BetaTunnelsCertificates

Create Tunnel Certificate
BetaTunnelCertificate beta().tunnels().certificates().create(CertificateCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/tunnels/{tunnel_id}/certificates
Get Tunnel Certificate
BetaTunnelCertificate beta().tunnels().certificates().retrieve(CertificateRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/tunnels/{tunnel_id}/certificates/{certificate_id}
List Tunnel Certificates
CertificateListPage beta().tunnels().certificates().list(CertificateListParamsparams = CertificateListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/tunnels/{tunnel_id}/certificates
Archive Tunnel Certificate
BetaTunnelCertificate beta().tunnels().certificates().archive(CertificateArchiveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

BetaOrganization

Get Current Organization
BetaOrganization beta().organization().retrieve(OrganizationRetrieveParamsparams = OrganizationRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/me

BetaOrganizationAPI Keys

List API Keys
ApiKeyListPage beta().organization().apiKeys().list(ApiKeyListParamsparams = ApiKeyListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/api_keys
Get API Key
BetaApiKey beta().organization().apiKeys().retrieve(ApiKeyRetrieveParamsparams = ApiKeyRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/api_keys/{api_key_id}
Update API Key
BetaApiKey beta().organization().apiKeys().update(ApiKeyUpdateParamsparams = ApiKeyUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/api_keys/{api_key_id}

BetaOrganizationExternal Keys

Create External Key
BetaExternalKey beta().organization().externalKeys().create(ExternalKeyCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/external_keys
List External Keys
ExternalKeyListPage beta().organization().externalKeys().list(ExternalKeyListParamsparams = ExternalKeyListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/external_keys
Get External Key
BetaExternalKey beta().organization().externalKeys().retrieve(ExternalKeyRetrieveParamsparams = ExternalKeyRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/external_keys/{external_key_id}
Update External Key
BetaExternalKey beta().organization().externalKeys().update(ExternalKeyUpdateParamsparams = ExternalKeyUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/external_keys/{external_key_id}
Delete External Key
ExternalKeyDeleteResponse beta().organization().externalKeys().delete(ExternalKeyDeleteParamsparams = ExternalKeyDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/v1/organizations/external_keys/{external_key_id}
Validate External Key
ExternalKeyValidateResponse beta().organization().externalKeys().validate(ExternalKeyValidateParamsparams = ExternalKeyValidateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/external_keys/{external_key_id}/validate

BetaOrganizationFederationIssuers

Create Federation Issuer
BetaFederationIssuer beta().organization().federation().issuers().create(IssuerCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/federation_issuers
List Federation Issuers
IssuerListPage beta().organization().federation().issuers().list(IssuerListParamsparams = IssuerListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/federation_issuers
Get Federation Issuer
BetaFederationIssuer beta().organization().federation().issuers().retrieve(IssuerRetrieveParamsparams = IssuerRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/federation_issuers/{federation_issuer_id}
Update Federation Issuer
BetaFederationIssuer beta().organization().federation().issuers().update(IssuerUpdateParamsparams = IssuerUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/federation_issuers/{federation_issuer_id}
Archive Federation Issuer
BetaFederationIssuer beta().organization().federation().issuers().archive(IssuerArchiveParamsparams = IssuerArchiveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

BetaOrganizationFederationRules

Create Federation Rule
BetaFederationRule beta().organization().federation().rules().create(RuleCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/federation_rules
List Federation Rules
RuleListPage beta().organization().federation().rules().list(RuleListParamsparams = RuleListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/federation_rules
Get Federation Rule
BetaFederationRule beta().organization().federation().rules().retrieve(RuleRetrieveParamsparams = RuleRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/federation_rules/{federation_rule_id}
Update Federation Rule
BetaFederationRule beta().organization().federation().rules().update(RuleUpdateParamsparams = RuleUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/federation_rules/{federation_rule_id}
Archive Federation Rule
BetaFederationRule beta().organization().federation().rules().archive(RuleArchiveParamsparams = RuleArchiveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

BetaOrganizationFederationRulesWorkspaces

Add Federation Rule Workspace
BetaFederationRuleWorkspace beta().organization().federation().rules().workspaces().add(WorkspaceAddParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces
List Federation Rule Workspaces
WorkspaceListPage beta().organization().federation().rules().workspaces().list(WorkspaceListParamsparams = WorkspaceListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Remove Federation Rule Workspace
WorkspaceRemoveResponse beta().organization().federation().rules().workspaces().remove(WorkspaceRemoveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

BetaOrganizationInvites

Create Invite
BetaOrganizationInvite beta().organization().invites().create(InviteCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/invites
List Invites
InviteListPage beta().organization().invites().list(InviteListParamsparams = InviteListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/invites
Get Invite
BetaOrganizationInvite beta().organization().invites().retrieve(InviteRetrieveParamsparams = InviteRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/invites/{invite_id}
Delete Invite
InviteDeleteResponse beta().organization().invites().delete(InviteDeleteParamsparams = InviteDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/v1/organizations/invites/{invite_id}

BetaOrganizationService Accounts

Create Service Account
BetaServiceAccount beta().organization().serviceAccounts().create(ServiceAccountCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/service_accounts
List Service Accounts
ServiceAccountListPage beta().organization().serviceAccounts().list(ServiceAccountListParamsparams = ServiceAccountListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/service_accounts
Get Service Account
BetaServiceAccount beta().organization().serviceAccounts().retrieve(ServiceAccountRetrieveParamsparams = ServiceAccountRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/service_accounts/{service_account_id}
Update Service Account
BetaServiceAccount beta().organization().serviceAccounts().update(ServiceAccountUpdateParamsparams = ServiceAccountUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/service_accounts/{service_account_id}
Archive Service Account
BetaServiceAccount beta().organization().serviceAccounts().archive(ServiceAccountArchiveParamsparams = ServiceAccountArchiveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/service_accounts/{service_account_id}/archive

BetaOrganizationService AccountsWorkspaces

Add Workspace To Service Account
BetaServiceAccountWorkspaceMember beta().organization().serviceAccounts().workspaces().add(WorkspaceAddParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/service_accounts/{service_account_id}/workspaces
List Workspaces For Service Account
WorkspaceListPage beta().organization().serviceAccounts().workspaces().list(WorkspaceListParamsparams = WorkspaceListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/service_accounts/{service_account_id}/workspaces
Remove Workspace From Service Account
WorkspaceRemoveResponse beta().organization().serviceAccounts().workspaces().remove(WorkspaceRemoveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

BetaOrganizationUsers

List Users
UserListPage beta().organization().users().list(UserListParamsparams = UserListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/users
Get User
BetaOrganizationUser beta().organization().users().retrieve(UserRetrieveParamsparams = UserRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/users/{user_id}
Update User
BetaOrganizationUser beta().organization().users().update(UserUpdateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/users/{user_id}
Remove User
UserRemoveResponse beta().organization().users().remove(UserRemoveParamsparams = UserRemoveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/v1/organizations/users/{user_id}

BetaOrganizationWorkspaces

List Workspaces
WorkspaceListPage beta().organization().workspaces().list(WorkspaceListParamsparams = WorkspaceListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/workspaces
Create Workspace
BetaWorkspace beta().organization().workspaces().create(WorkspaceCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/workspaces
Get Workspace
BetaWorkspace beta().organization().workspaces().retrieve(WorkspaceRetrieveParamsparams = WorkspaceRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}
Update Workspace
BetaWorkspace beta().organization().workspaces().update(WorkspaceUpdateParamsparams = WorkspaceUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}
Archive Workspace
BetaWorkspace beta().organization().workspaces().archive(WorkspaceArchiveParamsparams = WorkspaceArchiveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/archive

BetaOrganizationWorkspacesRate Limits

List Workspace Rate Limits
RateLimitListPage beta().organization().workspaces().rateLimits().list(RateLimitListParamsparams = RateLimitListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

BetaOrganizationWorkspacesMembers

List Workspace Members
MemberListPage beta().organization().workspaces().members().list(MemberListParamsparams = MemberListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/members
Create Workspace Member
BetaWorkspaceMember beta().organization().workspaces().members().add(MemberAddParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/members
Get Workspace Member
BetaWorkspaceMember beta().organization().workspaces().members().retrieve(MemberRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Update Workspace Member
BetaWorkspaceMember beta().organization().workspaces().members().update(MemberUpdateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Delete Workspace Member
MemberRemoveResponse beta().organization().workspaces().members().remove(MemberRemoveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

BetaOrganizationWorkspacesService Accounts

List Service Account Workspace Members
ServiceAccountListPage beta().organization().workspaces().serviceAccounts().list(ServiceAccountListParamsparams = ServiceAccountListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/service_accounts
Create Service Account Workspace Member
BetaServiceAccountWorkspaceMember beta().organization().workspaces().serviceAccounts().add(ServiceAccountAddParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/service_accounts
Get Service Account Workspace Member
BetaServiceAccountWorkspaceMember beta().organization().workspaces().serviceAccounts().retrieve(ServiceAccountRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Update Service Account Workspace Member
BetaServiceAccountWorkspaceMember beta().organization().workspaces().serviceAccounts().update(ServiceAccountUpdateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Delete Service Account Workspace Member
ServiceAccountRemoveResponse beta().organization().workspaces().serviceAccounts().remove(ServiceAccountRemoveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

BetaOrganizationRate Limits

List Organization Rate Limits
RateLimitListPage beta().organization().rateLimits().list(RateLimitListParamsparams = RateLimitListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/rate_limits