Follow Discord
Sweep 02 Oct 2026 · 18:55Z Build v2.1.288 509 read Stable v2.1.285 Latest v2.1.288 Next v2.1.288 Feeds RSS JSON llms.txt llms-full.txt Unofficial
HomeDocsSearch
Search the documentation

1,005 pages for path.

Titles and paths first, then pages whose text carries it. Each row opens that page as this site last read it.

Remote Claude Developer Platform · in the page api/compliance/apps/sessions/remote …s the key may read. A malformed session identifier returns 400. #### Path parameters - `claude_remote_session_id: string` The remote session identifier (`cse_...`) to retrieve #### Query paramet… Messages Claude Developer Platform · in the page api/compliance/apps/sessions/remote/messages …ns the key may read. A malformed session identifier returns 400. ### Path parameters - `claude_remote_session_id: string` The remote session identifier (`cse_...`) to retrieve ### Query paramete… Retrieve remote session messages Claude Developer Platform · in the page api/compliance/apps/sessions/remote/messages/list …ons the key may read. A malformed session identifier returns 400. ## Path parameters - `claude_remote_session_id: string` The remote session identifier (`cse_...`) to retrieve ## Query parameter… Code Claude Developer Platform · in the page api/compliance/code …for identity-stored content; validate against it when present. #### Path parameters - `artifact_id: string` The Artifact ID (tagged ID, e.g., cart_abc123) - `version_id: string` Opaque versi… Artifacts Claude Developer Platform · in the page api/compliance/code/artifacts …y for identity-stored content; validate against it when present. ### Path parameters - `artifact_id: string` The Artifact ID (tagged ID, e.g., cart_abc123) - `version_id: string` Opaque versi… Delete Code Artifact Claude Developer Platform · in the page api/compliance/code/artifacts/delete …Returns 404 on a repeated delete of an already-deleted Artifact. ## Path parameters - `artifact_id: string` The Artifact ID (tagged ID, e.g., cart_abc123) ## Headers - `"x-api-key": optional s… Download Code Artifact Version Content Claude Developer Platform · in the page api/compliance/code/artifacts/retrieve_version …ly for identity-stored content; validate against it when present. ## Path parameters - `artifact_id: string` The Artifact ID (tagged ID, e.g., cart_abc123) - `version_id: string` Opaque versi… Groups Claude Developer Platform · in the page api/compliance/groups …**GET** `/v1/compliance/groups/{group_id}` Get Compliance Group ### Path parameters - `group_id: string` The group ID (tagged ID, e.g., rbac_group_abc123) ### Headers - `"x-api-key": optional… Members Claude Developer Platform · in the page api/compliance/groups/members …liance/groups/{group_id}/members` List Compliance Group Members ### Path parameters - `group_id: string` The group ID (tagged ID, e.g., rbac_group_abc123) ### Query parameters - `limit: option… List Compliance Group Members Claude Developer Platform · in the page api/compliance/groups/members/list …pliance/groups/{group_id}/members` List Compliance Group Members ## Path parameters - `group_id: string` The group ID (tagged ID, e.g., rbac_group_abc123) ## Query parameters - `limit: optiona… Get Compliance Group Claude Developer Platform · in the page api/compliance/groups/retrieve …**GET** `/v1/compliance/groups/{group_id}` Get Compliance Group ## Path parameters - `group_id: string` The group ID (tagged ID, e.g., rbac_group_abc123) ## Headers - `"x-api-key": optional s… Organizations Claude Developer Platform · in the page api/compliance/organizations …org_uuid}/users` List current user members of an organization. #### Path parameters - `org_uuid: string` The organization UUID #### Query parameters - `limit: optional number` Maximum resul… Roles Claude Developer Platform · in the page api/compliance/organizations/roles …ompliance/organizations/{org_uuid}/roles` List Compliance Roles ### Path parameters - `org_uuid: string` The organization UUID ### Query parameters - `limit: optional number` Maximum result… List Compliance Roles Claude Developer Platform · in the page api/compliance/organizations/roles/list …compliance/organizations/{org_uuid}/roles` List Compliance Roles ## Path parameters - `org_uuid: string` The organization UUID ## Query parameters - `limit: optional number` Maximum results… Permissions Claude Developer Platform · in the page api/compliance/organizations/roles/permissions …}/roles/{role_id}/permissions` List Compliance Role Permissions ### Path parameters - `org_uuid: string` The organization UUID - `role_id: string` The role ID (tagged ID, e.g., rbac_role_abc… List Compliance Role Permissions Claude Developer Platform · in the page api/compliance/organizations/roles/permissions/list …d}/roles/{role_id}/permissions` List Compliance Role Permissions ## Path parameters - `org_uuid: string` The organization UUID - `role_id: string` The role ID (tagged ID, e.g., rbac_role_abc… Get Compliance Role Claude Developer Platform · in the page api/compliance/organizations/roles/retrieve …ce/organizations/{org_uuid}/roles/{role_id}` Get Compliance Role ## Path parameters - `org_uuid: string` The organization UUID - `role_id: string` The role ID (tagged ID, e.g., rbac_role_abc… Settings Claude Developer Platform · in the page api/compliance/organizations/settings …rganizations and organizations outside the hierarchy return 404. ### Path parameters - `organization_id: string` The organization's UUID ### Headers - `"x-api-key": optional string` ### Return… Get effective organization settings Claude Developer Platform · in the page api/compliance/organizations/settings/retrieve …organizations and organizations outside the hierarchy return 404. ## Path parameters - `organization_id: string` The organization's UUID ## Headers - `"x-api-key": optional string` ## Returns… Users Claude Developer Platform · in the page api/compliance/organizations/users …{org_uuid}/users` List current user members of an organization. ### Path parameters - `org_uuid: string` The organization UUID ### Query parameters - `limit: optional number` Maximum result… List organization users Claude Developer Platform · in the page api/compliance/organizations/users/list …/{org_uuid}/users` List current user members of an organization. ## Path parameters - `org_uuid: string` The organization UUID ## Query parameters - `limit: optional number` Maximum results… errors Claude Developer Platform · in the page api/errors …ound_error`: The requested resource was not found. Check the endpoint path and any resource IDs in the request URL. * 409 - `conflict_error`: The request conflicts with the current state of a resourc… Files Claude Developer Platform · in the page api/files …s (form-data) - `file: string` The file to upload. Only the final path component of the part's `filename` is kept; an absent or empty `filename` is replaced with `unnamed` plus the extension for t… Delete File Claude Developer Platform · in the page api/files/delete …--- # Delete File **DELETE** `/v1/files/{file_id}` Delete File ## Path parameters - `file_id: string` ID of the File. ## Headers - `"anthropic-workspace-id": optional string` Optional hea… Download File Claude Developer Platform · in the page api/files/download …wnload File **GET** `/v1/files/{file_id}/content` Download File ## Path parameters - `file_id: string` ID of the File. ## Headers - `"anthropic-workspace-id": optional string` Optional hea… Get File Metadata Claude Developer Platform · in the page api/files/retrieve_metadata …t File Metadata **GET** `/v1/files/{file_id}` Get File Metadata ## Path parameters - `file_id: string` ID of the File. ## Headers - `"anthropic-workspace-id": optional string` Optional hea… Upload File Claude Developer Platform · in the page api/files/upload …s (form-data) - `file: string` The file to upload. Only the final path component of the part's `filename` is kept; an absent or empty `filename` is replaced with `unnamed` plus the extension for t… Messages Claude Developer Platform · in the page api/messages …, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `path: optional string or null` Where the executor saved the file, on the executor's filesystem. Only included… Batches Claude Developer Platform · in the page api/messages/batches …ttern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `path: optional string or null` Where the executor saved the file, on the executor's filesystem. Only incl… Cancel a Message Batch Claude Developer Platform · in the page api/messages/batches/cancel …//platform.claude.com/docs/en/build-with-claude/batch-processing) ## Path parameters - `message_batch_id: string` ID of the Message Batch. ## Headers - `"anthropic-workspace-id": optional strin… Create a Message Batch Claude Developer Platform · in the page api/messages/batches/create …ttern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `path: optional string or null` Where the executor saved the file, on the executor's filesystem. Only incl… Delete a Message Batch Claude Developer Platform · in the page api/messages/batches/delete …//platform.claude.com/docs/en/build-with-claude/batch-processing) ## Path parameters - `message_batch_id: string` ID of the Message Batch. ## Headers - `"anthropic-workspace-id": optional strin… Retrieve Message Batch results Claude Developer Platform · in the page api/messages/batches/results …//platform.claude.com/docs/en/build-with-claude/batch-processing) ## Path parameters - `message_batch_id: string` ID of the Message Batch. ## Headers - `"anthropic-workspace-id": optional strin… Retrieve a Message Batch Claude Developer Platform · in the page api/messages/batches/retrieve …//platform.claude.com/docs/en/build-with-claude/batch-processing) ## Path parameters - `message_batch_id: string` ID of the Message Batch. ## Headers - `"anthropic-workspace-id": optional strin… Count tokens in a Message Claude Developer Platform · in the page api/messages/count_tokens …, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `path: optional string or null` Where the executor saved the file, on the executor's filesystem. Only included… Create a Message Claude Developer Platform · in the page api/messages/create …, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `path: optional string or null` Where the executor saved the file, on the executor's filesystem. Only included… Models Claude Developer Platform · in the page api/models …n about a specific model or resolve a model alias to a model ID. ### Path parameters - `model_id: string` Model identifier or alias. ### Headers - `"anthropic-workspace-id": optional string`… Get a Model Claude Developer Platform · in the page api/models/retrieve …on about a specific model or resolve a model alias to a model ID. ## Path parameters - `model_id: string` Model identifier or alias. ## Headers - `"anthropic-workspace-id": optional string`… Organization Claude Developer Platform · in the page api/organization …tps://platform.claude.com/settings/keys) in the Claude Console. #### Path parameters - `api_key_id: string` ID of the API key. #### Returns - `APIKey object` - `type: "api_key"` Object… API Keys Claude Developer Platform · in the page api/organization/api_keys …ttps://platform.claude.com/settings/keys) in the Claude Console. ### Path parameters - `api_key_id: string` ID of the API key. ### Returns - `APIKey object` - `type: "api_key"` Object t… Retrieve API Key (Admin API) Claude Developer Platform · in the page api/organization/api_keys/retrieve …https://platform.claude.com/settings/keys) in the Claude Console. ## Path parameters - `api_key_id: string` ID of the API key. ## Returns - `APIKey object` - `type: "api_key"` Object ty… Update API Key Claude Developer Platform · in the page api/organization/api_keys/update …*POST** `/v1/organizations/api_keys/{api_key_id}` Update API Key ## Path parameters - `api_key_id: string` ID of the API key. ## Body parameters - `name: optional string or null` Name of th… External Keys Claude Developer Platform · in the page api/organization/external_keys …uding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. - `ExternalKeyAttachedAttachment object` - `type: "attached"… Create External Key Claude Developer Platform · in the page api/organization/external_keys/create …uding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. - `ExternalKeyAttachedAttachment object` - `type: "attached"… Delete External Key Claude Developer Platform · in the page api/organization/external_keys/delete …equest is rejected if any workspace still references this config. ## Path parameters - `external_key_id: string` ID of the External Key. maxLength: 2048 ## Returns - `type: "external_key_del… List External Keys Claude Developer Platform · in the page api/organization/external_keys/list …uding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. - `ExternalKeyAttachedAttachment object` - `type: "attached"… Get External Key Claude Developer Platform · in the page api/organization/external_keys/retrieve …a single external key config in the caller's organization by ID. ## Path parameters - `external_key_id: string` ID of the External Key. maxLength: 2048 ## Returns - `ExternalKey object`… Update External Key Claude Developer Platform · in the page api/organization/external_keys/update …sly encrypted data requires the original key identity to decrypt. ## Path parameters - `external_key_id: string` ID of the External Key. maxLength: 2048 ## Body parameters - `display_name: o… Validate External Key Claude Developer Platform · in the page api/organization/external_keys/validate …ed, or `failure` with an error message if it failed or timed out. ## Path parameters - `external_key_id: string` ID of the External Key. maxLength: 2048 ## Returns - `type: "external_key_val… Federation Claude Developer Platform · in the page api/organization/federation …min-api). Retrieve a federation issuer by its ID (`fdis_...`). #### Path parameters - `federation_issuer_id: string` ID of the federation issuer. #### Returns - `FederationIssuer object` Re…
Feedback