1,291 pages for type.

Create Action URL Claude Developer Platform · in the page api/beta/user_profiles/action_urls/create …he end-user that the profile represents enrolls in a program. - `type: "enroll_end_user"` ## Returns - `BetaUserProfileActionURL object` A URL to give to the person who takes the requested a… Create User Profile Claude Developer Platform · in the page api/beta/user_profiles/create …if sent, it must match that Workspace. ## Body parameters - `access_type: optional "application" or "passthrough"` How the platform uses the API for this entity. `application` (default): the prof… Create Enrollment URL Claude Developer Platform · in the page api/beta/user_profiles/create_enrollment_url …profile represents, so that the entity can enroll in a program. - `type: "enrollment_url"` Object type. Always `enrollment_url`. - `expires_at: string` When this enrollment URL expires… Delete User Profile Claude Developer Platform · in the page api/beta/user_profiles/delete …that Workspace. ## Returns - `BetaDeletedUserProfile object` - `type: "user_profile_deleted"` Object type. Always `user_profile_deleted`. - `id: string` Identifier of the deleted us… List User Profiles Claude Developer Platform · in the page api/beta/user_profiles/list …`data: array of BetaUserProfile` User profiles on this page. - `type: "user_profile"` Object type. Always `user_profile`. - `id: string` Unique identifier for this user profile, pre… Get User Profile Claude Developer Platform · in the page api/beta/user_profiles/retrieve …ser-profile-id` header to attribute the request to that entity. - `type: "user_profile"` Object type. Always `user_profile`. - `id: string` Unique identifier for this user profile, pre… Update User Profile Claude Developer Platform · in the page api/beta/user_profiles/update …if sent, it must match that Workspace. ## Body parameters - `access_type: optional "application" or "passthrough" or null` If present, replaces the stored access type. Omit to leave unchanged.… Vaults Claude Developer Platform · in the page api/beta/vaults …ault that stores credentials for use by agents during sessions. - `type: "vault"` - `id: string` The unique ID of the vault (`vlt_...`). - `archived_at: string or null` When the vau… Archive a Vault Claude Developer Platform · in the page api/beta/vaults/archive …ault that stores credentials for use by agents during sessions. - `type: "vault"` - `id: string` The unique ID of the vault (`vlt_...`). - `archived_at: string or null` When the vau… Create a Vault Claude Developer Platform · in the page api/beta/vaults/create …ault that stores credentials for use by agents during sessions. - `type: "vault"` - `id: string` The unique ID of the vault (`vlt_...`). - `archived_at: string or null` When the vau… Credentials Claude Developer Platform · in the page api/beta/vaults/credentials …object` Parameters for creating an MCP OAuth credential. - `type: "mcp_oauth"` - `access_token: string` The OAuth access token to send to the MCP server. minLength: 1, max… Archive a Credential Claude Developer Platform · in the page api/beta/vaults/credentials/archive …d in a vault. Sensitive fields are never returned in responses. - `type: "vault_credential"` - `id: string` The unique ID of the credential (`vcrd_...`). - `archived_at: string or null`… Create a Credential Claude Developer Platform · in the page api/beta/vaults/credentials/create …object` Parameters for creating an MCP OAuth credential. - `type: "mcp_oauth"` - `access_token: string` The OAuth access token to send to the MCP server. minLength: 1, max… Delete a Credential Claude Developer Platform · in the page api/beta/vaults/credentials/delete …etedCredential object` Confirmation of a deleted credential. - `type: "vault_credential_deleted"` - `id: string` The unique ID of the deleted credential (`vcrd_...`). ## Example ```bas… List Credentials Claude Developer Platform · in the page api/beta/vaults/credentials/list …gentsCredential` The credentials on this page, newest first. - `type: "vault_credential"` - `id: string` The unique ID of the credential (`vcrd_...`). - `archived_at: string or null`… Validate an MCP OAuth Credential Claude Developer Platform · in the page api/beta/vaults/credentials/mcp_oauth_validate …of live-probing a credential against its configured MCP server. - `type: "vault_credential_validation"` - `credential_id: string` Unique identifier of the credential that was validated.… Retrieve a Credential Claude Developer Platform · in the page api/beta/vaults/credentials/retrieve …d in a vault. Sensitive fields are never returned in responses. - `type: "vault_credential"` - `id: string` The unique ID of the credential (`vcrd_...`). - `archived_at: string or null`… Update a Credential Claude Developer Platform · in the page api/beta/vaults/credentials/update …UpdateParams` New authentication settings for the credential. The `type` must match the credential's current type, which can't be changed. - `BetaManagedAgentsMCPOAuthUpdateParams object` P… Delete a Vault Claude Developer Platform · in the page api/beta/vaults/delete …dAgentsDeletedVault object` Confirmation of a deleted vault. - `type: "vault_deleted"` - `id: string` The unique ID of the deleted vault (`vlt_...`). ## Example ```bash curl https://ap… List Vaults Claude Developer Platform · in the page api/beta/vaults/list …taManagedAgentsVault` The vaults on this page, newest first. - `type: "vault"` - `id: string` The unique ID of the vault (`vlt_...`). - `archived_at: string or null` When the vau… Retrieve a Vault Claude Developer Platform · in the page api/beta/vaults/retrieve …ault that stores credentials for use by agents during sessions. - `type: "vault"` - `id: string` The unique ID of the vault (`vlt_...`). - `archived_at: string or null` When the vau… Update a Vault Claude Developer Platform · in the page api/beta/vaults/update …ault that stores credentials for use by agents during sessions. - `type: "vault"` - `id: string` The unique ID of the vault (`vlt_...`). - `archived_at: string or null` When the vau… Webhooks Claude Developer Platform · in the page api/beta/webhooks …tform.claude.com/docs/en/api/beta/webhooks --- # Webhooks ## Domain types ### Beta Webhook Agent Archived Event Data - `BetaWebhookAgentArchivedEventData object` - `type: "agent.archived"` -… routines-fire Claude Developer Platform · in the page api/claude-code/routines-fire …ROUTINE_TOKEN" \ -H "anthropic-version: 2026-10-21" \ -H "Content-Type: application/json" \ -d '{"text": "Sentry alert SEN-4521 fired in prod. Stack trace attached."}' ``` ```yaml GitHub Action… claude-platform-on-aws-iam-actions Claude Developer Platform · in the page api/claude-platform-on-aws-iam-actions …| | **IAM service prefix** | `aws-external-anthropic` | | **Resource types** | `workspace` | Workspace ARN format: ```text wrap arn:aws:aws-external-anthropic:{region}:{account-id}… Completions Claude Developer Platform · in the page api/completions …. minimum: 0, maximum: 1 ### Returns - `Completion object` - `type: "completion"` Object type. For Text Completions, this is always `"completion"`. default: completion - `id:… Create a Text Completion Claude Developer Platform · in the page api/completions/create …y. minimum: 0, maximum: 1 ## Returns - `Completion object` - `type: "completion"` Object type. For Text Completions, this is always `"completion"`. default: completion - `id:… Compliance API Claude Developer Platform · in the page api/compliance …be filtered by various criteria. #### Query parameters - `activity_types: optional array of "abuse_decision_received" or "account_deleted" or "account_migration_completed" or 558 more` Filter ac… Activities Claude Developer Platform · in the page api/compliance/activities …n be filtered by various criteria. ### Query parameters - `activity_types: optional array of "abuse_decision_received" or "account_deleted" or "account_migration_completed" or 558 more` Filter ac… Query compliance activities Claude Developer Platform · in the page api/compliance/activities/list …an be filtered by various criteria. ## Query parameters - `activity_types: optional array of "abuse_decision_received" or "account_deleted" or "account_migration_completed" or 558 more` Filter ac… Apps Claude Developer Platform · in the page api/compliance/apps …_languages=http). - `"x-api-key": optional string` #### Returns - `type: optional "claude_chat_deleted"` Constant string confirming deletion default: claude_chat_deleted - `id: string` Th… Artifacts Claude Developer Platform · in the page api/compliance/apps/artifacts …id: string` Artifact ID e.g. 'claude_artifact_abc123' - `artifact_type: string or null` MIME-like artifact type e.g. 'application/vnd.ant.code' - `claude_chat_id: string` The chat this arti… Get artifact metadata Claude Developer Platform · in the page api/compliance/apps/artifacts/retrieve …id: string` Artifact ID e.g. 'claude_artifact_abc123' - `artifact_type: string or null` MIME-like artifact type e.g. 'application/vnd.ant.code' - `claude_chat_id: string` The chat this arti… Chats Claude Developer Platform · in the page api/compliance/apps/chats …k_languages=http). - `"x-api-key": optional string` ### Returns - `type: optional "claude_chat_deleted"` Constant string confirming deletion default: claude_chat_deleted - `id: string` Th… Delete chat Claude Developer Platform · in the page api/compliance/apps/chats/delete …dk_languages=http). - `"x-api-key": optional string` ## Returns - `type: optional "claude_chat_deleted"` Constant string confirming deletion default: claude_chat_deleted - `id: string` Th… Files Claude Developer Platform · in the page api/compliance/apps/chats/files …attached to. A file can be referenced by multiple messages. - `mime_type: string or null` MIME type of the file's preferred downloadable variant (e.g. 'application/pdf'). May be null for files wi… Delete file Claude Developer Platform · in the page api/compliance/apps/chats/files/delete …dk_languages=http). - `"x-api-key": optional string` ## Returns - `type: optional "claude_file_deleted"` Constant string confirming deletion default: claude_file_deleted - `id: string` Th… Get file metadata Claude Developer Platform · in the page api/compliance/apps/chats/files/retrieve …attached to. A file can be referenced by multiple messages. - `mime_type: string or null` MIME type of the file's preferred downloadable variant (e.g. 'application/pdf'). May be null for files wi… Generated Files Claude Developer Platform · in the page api/compliance/apps/chats/generated_files …(base64 per RFC 1864) computed over the exact served bytes. - `mime_type: string or null` MIME type of the stored file, when available - `size_bytes: number or null` Size in bytes of the stor… Get Claude-generated file metadata Claude Developer Platform · in the page api/compliance/apps/chats/generated_files/retrieve …(base64 per RFC 1864) computed over the exact served bytes. - `mime_type: string or null` MIME type of the stored file, when available - `size_bytes: number or null` Size in bytes of the stor… Messages Claude Developer Platform · in the page api/compliance/apps/chats/messages …ng` Artifact ID e.g. 'claude_artifact_abc123' - `artifact_type: string or null` MIME-like artifact type e.g. 'application/vnd.ant.code' - `title: string or null` Artifac… Get chat messages Claude Developer Platform · in the page api/compliance/apps/chats/messages/list …ng` Artifact ID e.g. 'claude_artifact_abc123' - `artifact_type: string or null` MIME-like artifact type e.g. 'application/vnd.ant.code' - `title: string or null` Artifac… Code Claude Developer Platform · in the page api/compliance/apps/code …- `id: string` Artifact identifier (tagged ID) - `artifact_type: "claude_dashboards" or "claude_design" or "claude_design_systems" or 5 more` Which kind of Artifact this is: `code` for… Artifacts Claude Developer Platform · in the page api/compliance/apps/code/artifacts …- `id: string` Artifact identifier (tagged ID) - `artifact_type: "claude_dashboards" or "claude_design" or "claude_design_systems" or 5 more` Which kind of Artifact this is: `code` for… Delete Code Artifact Claude Developer Platform · in the page api/compliance/apps/code/artifacts/delete …dk_languages=http). - `"x-api-key": optional string` ## Returns - `type: "code_artifact_deleted"` Constant string confirming deletion default: code_artifact_deleted - `id: string` The ID… Download Code Artifact Content Claude Developer Platform · in the page api/compliance/apps/code/artifacts/download …h no `Content-Length`. For a Claude Doc (an Artifact whose `artifact_type` is `claude_docs`), the request must set `multi_file_format=zip`, and the content is the Doc's text as a ZIP archive of Word… List Code Artifacts Claude Developer Platform · in the page api/compliance/apps/code/artifacts/list …- `id: string` Artifact identifier (tagged ID) - `artifact_type: "claude_dashboards" or "claude_design" or "claude_design_systems" or 5 more` Which kind of Artifact this is: `code` for… Download Code Artifact Version Content Claude Developer Platform · in the page api/compliance/apps/code/artifacts/retrieve_version …than one file, other than a Claude Doc's (an Artifact whose `artifact_type` is `claude_docs`), comes back as a ZIP archive of its files. Headers: `Content-Type` (`application/zip` for a ZIP archive,… Projects Claude Developer Platform · in the page api/compliance/apps/projects …k_languages=http). - `"x-api-key": optional string` ### Returns - `type: optional "claude_project_deleted"` Constant string confirming deletion. default: claude_project_deleted - `id: string… Attachments Claude Developer Platform · in the page api/compliance/apps/projects/attachments …ect` File attachment reference for compliance responses. - `type: "project_file"` Discriminator marking this as a binary file default: project_file - `id: string` F…