Follow Discord
Sweep 22 Oct 2026 · 21:04Z Build v2.1.309 528 read Stable v2.1.308 Latest v2.1.309 Next v2.1.309 Feeds RSS JSON llms.txt llms-full.txt Unofficial
HomeDocsSearch
Search the documentation

1,296 pages for type.

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

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… List project attachments Claude Developer Platform · in the page api/compliance/apps/projects/attachments/list …ect` File attachment reference for compliance responses. - `type: "project_file"` Discriminator marking this as a binary file default: project_file - `id: string` F… Collaborators Claude Developer Platform · in the page api/compliance/apps/projects/collaborators …on the project. Principals are returned as a discriminated union on `type` — an individual user, an RBAC group, the whole organization, or all holders of an organization-level role. ### Path paramet… List project collaborators Claude Developer Platform · in the page api/compliance/apps/projects/collaborators/list …on the project. Principals are returned as a discriminated union on `type` — an individual user, an RBAC group, the whole organization, or all holders of an organization-level role. ## Path paramete… Delete project Claude Developer Platform · in the page api/compliance/apps/projects/delete …dk_languages=http). - `"x-api-key": optional string` ## Returns - `type: optional "claude_project_deleted"` Constant string confirming deletion. default: claude_project_deleted - `id: string… Documents Claude Developer Platform · in the page api/compliance/apps/projects/documents …he `content` field returned by the sibling content endpoint. - `mime_type: "text/plain"` MIME type of the document content, always plain text default: text/plain - `size_bytes: number` Size… Delete project document Claude Developer Platform · in the page api/compliance/apps/projects/documents/delete …dk_languages=http). - `"x-api-key": optional string` ## Returns - `type: "claude_project_document_deleted"` Constant string confirming deletion. default: claude_project_document_deleted - `i… Get project document metadata Claude Developer Platform · in the page api/compliance/apps/projects/documents/metadata …he `content` field returned by the sibling content endpoint. - `mime_type: "text/plain"` MIME type of the document content, always plain text default: text/plain - `size_bytes: number` Size… Sessions Claude Developer Platform · in the page api/compliance/apps/sessions …ters on it without changing the order or the pagination cursor. - `type: "compliance_local_session"` default: compliance_local_session - `id: string` Local session identifier, prefixed… Local Claude Developer Platform · in the page api/compliance/apps/sessions/local …ters on it without changing the order or the pagination cursor. - `type: "compliance_local_session"` default: compliance_local_session - `id: string` Local session identifier, prefixed… List local sessions Claude Developer Platform · in the page api/compliance/apps/sessions/local/list …ters on it without changing the order or the pagination cursor. - `type: "compliance_local_session"` default: compliance_local_session - `id: string` Local session identifier, prefixed… Messages Claude Developer Platform · in the page api/compliance/apps/sessions/local/messages …her in transcript order; a page boundary can fall between them. - `type: "compliance_local_session_message"` default: compliance_local_session_message - `id: string` Message identifier… Retrieve local session messages Claude Developer Platform · in the page api/compliance/apps/sessions/local/messages/list …her in transcript order; a page boundary can fall between them. - `type: "compliance_local_session_message"` default: compliance_local_session_message - `id: string` Message identifier… Retrieve a local session Claude Developer Platform · in the page api/compliance/apps/sessions/local/retrieve …dk_languages=http). - `"x-api-key": optional string` ## Returns - `type: "compliance_local_session"` default: compliance_local_session - `id: string` Local session identifier, prefixed `clls… Remote Claude Developer Platform · in the page api/compliance/apps/sessions/remote …XyZaBcDeFgH" } ], "next_page": "page_AAE..." } ``` ## Domain types ### Remote List Response - `RemoteListResponse object` Metadata for one remote session, as returned in the list respons… Messages Claude Developer Platform · in the page api/compliance/apps/sessions/remote/messages …the message - `Text object` Text content block. - `type: "text"` default: text - `text: string` Text content from the user or the assistant - `trunca… Retrieve remote session messages Claude Developer Platform · in the page api/compliance/apps/sessions/remote/messages/list …the message - `Text object` Text content block. - `type: "text"` default: text - `text: string` Text content from the user or the assistant - `trunca… Groups Claude Developer Platform · in the page api/compliance/groups …of string or null` Role IDs assigned to this group. - `source_type: string` How the group was created ('direct' or 'scim') - `updated_at: string or null` Group last-updated timest… List Compliance Groups Claude Developer Platform · in the page api/compliance/groups/list …of string or null` Role IDs assigned to this group. - `source_type: string` How the group was created ('direct' or 'scim') - `updated_at: string or null` Group last-updated timest… Members Claude Developer Platform · in the page api/compliance/groups/members …xt_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA=" } ``` ## Domain types ### Member List Response - `MemberListResponse object` Group member for compliance responses. - `created_at: string… Get Compliance Group Claude Developer Platform · in the page api/compliance/groups/retrieve …ray of string or null` Role IDs assigned to this group. - `source_type: string` How the group was created ('direct' or 'scim') - `updated_at: string or null` Group last-updated timestamp (R… Organizations Claude Developer Platform · in the page api/compliance/organizations …xt_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA=" } ``` ## Domain types ### Organization List Response - `OrganizationListResponse object` Information about an organization. - `created_at:… Roles Claude Developer Platform · in the page api/compliance/organizations/roles …dmin", "updated_at": "2025-03-14T09:05:17.456789Z" } ``` ## Domain types ### Role Retrieve Response - `RoleRetrieveResponse object` Role information for compliance responses. - `id: string`… Permissions Claude Developer Platform · in the page api/compliance/organizations/roles/permissions …Identifier of the resource the permission applies to - `resource_type: string` Type of resource the permission applies to - `has_more: boolean` Whether more records exist beyond the curr… List Compliance Role Permissions Claude Developer Platform · in the page api/compliance/organizations/roles/permissions/list …Identifier of the resource the permission applies to - `resource_type: string` Type of resource the permission applies to - `has_more: boolean` Whether more records exist beyond the curr… Settings Claude Developer Platform · in the page api/compliance/organizations/settings …k_languages=http). - `"x-api-key": optional string` ### Returns - `type: optional "effective_organization_settings"` default: effective_organization_settings - `api_keys: array of object` Co… Get effective organization settings Claude Developer Platform · in the page api/compliance/organizations/settings/retrieve …dk_languages=http). - `"x-api-key": optional string` ## Returns - `type: optional "effective_organization_settings"` default: effective_organization_settings - `api_keys: array of object` Co… User Preferences Claude Developer Platform · in the page api/compliance/organizations/user_preferences …xt_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA=" } ``` ## Domain types ### User Preference List Response - `UserPreferenceListResponse object` The personal preferences a member of the organi… Users Claude Developer Platform · in the page api/compliance/organizations/users …xt_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA=" } ``` ## Domain types ### User List Response - `UserListResponse object` User member information for compliance responses. - `id: string`… errors Claude Developer Platform · in the page api/errors …request IDs the Claude API returns, and handle errors with the SDK's typed exceptions. --- ## HTTP errors The API follows a predictable HTTP error code format: * 400 - `invalid_request_error`: The… Files Claude Developer Platform · in the page api/files …eplaced with `unnamed` plus the extension for the file's stored `mime_type`, when known. format: binary - `expires_in_seconds: optional number` Seconds from upload until the file expires and it… Delete File Claude Developer Platform · in the page api/files/delete …must match that Workspace. ## Returns - `DeletedFile object` - `type: optional "file_deleted"` Deleted object type. For file deletion, this is always `"file_deleted"`. default: fi… List Files Claude Developer Platform · in the page api/files/list …`data: array of FileMetadata` List of file metadata objects. - `type: "file"` Object type. For files, this is always `"file"`. - `id: string` Unique object identifier. The… Get File Metadata Claude Developer Platform · in the page api/files/retrieve_metadata …must match that Workspace. ## Returns - `FileMetadata object` - `type: "file"` Object type. For files, this is always `"file"`. - `id: string` Unique object identifier. The… Upload File Claude Developer Platform · in the page api/files/upload …eplaced with `unnamed` plus the extension for the file's stored `mime_type`, when known. format: binary - `expires_in_seconds: optional number` Seconds from upload until the file expires and it… Messages Claude Developer Platform · in the page api/messages …ring` or an array of content blocks, where each block has a specific `type`. Using a `string` for `content` is shorthand for an array of one content block of type `"text"`. The following input message… Batches Claude Developer Platform · in the page api/messages/batches …ring` or an array of content blocks, where each block has a specific `type`. Using a `string` for `content` is shorthand for an array of one content block of type `"text"`. The following input message… Cancel a Message Batch Claude Developer Platform · in the page api/messages/batches/cancel …must match that Workspace. ## Returns - `MessageBatch object` - `type: "message_batch"` Object type. For Message Batches, this is always `"message_batch"`. default: message_batch… Create a Message Batch Claude Developer Platform · in the page api/messages/batches/create …ring` or an array of content blocks, where each block has a specific `type`. Using a `string` for `content` is shorthand for an array of one content block of type `"text"`. The following input message… Delete a Message Batch Claude Developer Platform · in the page api/messages/batches/delete …tch that Workspace. ## Returns - `DeletedMessageBatch object` - `type: "message_batch_deleted"` Deleted object type. For Message Batches, this is always `"message_batch_deleted"`.… List Message Batches Claude Developer Platform · in the page api/messages/batches/list …ch that Workspace. ## Returns - `data: array of MessageBatch` - `type: "message_batch"` Object type. For Message Batches, this is always `"message_batch"`. default: message_batch… Retrieve Message Batch results Claude Developer Platform · in the page api/messages/batches/results …or expiration. - `MessageBatchSucceededResult object` - `type: "succeeded"` default: succeeded - `message: Message` - `type: "message"` Object type.… Retrieve a Message Batch Claude Developer Platform · in the page api/messages/batches/retrieve …must match that Workspace. ## Returns - `MessageBatch object` - `type: "message_batch"` Object type. For Message Batches, this is always `"message_batch"`. default: message_batch… Count tokens in a Message Claude Developer Platform · in the page api/messages/count_tokens …ring` or an array of content blocks, where each block has a specific `type`. Using a `string` for `content` is shorthand for an array of one content block of type `"text"`. The following input message… Create a Message Claude Developer Platform · in the page api/messages/create …ring` or an array of content blocks, where each block has a specific `type`. Using a `string` for `content` is shorthand for an array of one content block of type `"text"`. The following input message… Before Claude Developer Platform · in the page api/migration-2026-10-21 …-H "anthropic-version: 2026-10-21" \ -H "content-type: application/json" \ -d '{ "model": "claude-opus-5-5", "max_tokens": 1024, "mes… Models Claude Developer Platform · in the page api/models …atch that Workspace. ### Returns - `data: array of ModelInfo` - `type: "model"` Object type. For Models, this is always `"model"`. default: model - `id: string` Unique mode… List Models Claude Developer Platform · in the page api/models/list …match that Workspace. ## Returns - `data: array of ModelInfo` - `type: "model"` Object type. For Models, this is always `"model"`. default: model - `id: string` Unique mode… Get a Model Claude Developer Platform · in the page api/models/retrieve …it must match that Workspace. ## Returns - `ModelInfo object` - `type: "model"` Object type. For Models, this is always `"model"`. default: model - `id: string` Unique mode… spans Claude Developer Platform · in the page api/opentelemetry/spans …spans can have only the first three: | Attribute | Type | Description…
Feedback