One read of Claude Developer Platformapi-20260814T043121Z
565 pages moved out of 565 read.
Pages moved
565
significant first
Pages read
565
in this capture
Captured
04:31 UTC
Corpus hash
764ab7e8e96e
full baseline · corpus-hash
What this read moved
351-375 of 565, page 15 of 23This capture is too large to show at once. Changes 351-375 of 565 are below, significant first; the rest are on the following screens.
api/compliance/apps/chats/delete First recorded · 50 lines, first recorded
## Delete chat ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Delete chat
url: https://platform.claude.com/docs/en/api/compliance/apps/chats/delete
---
## Delete chat
**delete** `/v1/compliance/apps/chats/{claude_chat_id}`
Permanently deletes a chat and all associated messages and
files. This is a destructive operation that cannot be undone.
### Path Parameters
- `claude_chat_id: string`
The chat ID (tagged ID, e.g., claude_chat_abc123)
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `id: string`
The ID of the Claude chat that was deleted
- `type: optional "claude_chat_deleted"`
Constant string confirming deletion
- `"claude_chat_deleted"`
### Example
```http
curl https://api.anthropic.com/v1/compliance/apps/chats/$CLAUDE_CHAT_ID \
-X DELETE \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
#### Response
```json
{
"id": "claude_chat_abc123",
"type": "claude_chat_deleted"
}
```
api/compliance/apps/chats/files First recorded · 212 lines, first recorded
# Files ## Get file metadata ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Delete file ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Download file content ### Path Parameters ### Header Parameters ### Example ## Domain Types ### File Retrieve Response ### File Delete Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Files
url: https://platform.claude.com/docs/en/api/compliance/apps/chats/files
---
# Files
## Get file metadata
**get** `/v1/compliance/apps/chats/files/{claude_file_id}`
Retrieves metadata for a file referenced in chat messages, without
downloading the file content. Use the sibling `/content` endpoint to
download the bytes.
### Path Parameters
- `claude_file_id: string`
The file ID (tagged ID, e.g., claude_file_abc123)
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `id: string`
File ID
- `claude_chat_ids: array of string`
Chats this file is attached to. A file can be referenced by messages across multiple chats.
- `created_at: string`
File creation timestamp
- `filename: string or null`
Display name of the file, if set
- `md5: string or null`
Lowercase hex MD5 of the file's preferred downloadable variant, as recorded at upload time. Null when no stored hash is available. The sibling `/content` endpoint also sets a `Content-MD5` header (base64 per RFC 1864) computed over the exact served bytes; when the two disagree, the header is authoritative.
- `message_ids: array of string`
Chat message IDs this file is 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 with no downloadable content (e.g. code-interpreter outputs).
- `size_bytes: number or null`
Size in bytes of the file's preferred downloadable variant, if known
### Example
```http
curl https://api.anthropic.com/v1/compliance/apps/chats/files/$CLAUDE_FILE_ID \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
#### Response
```json
{
"id": "claude_file_xyz789",
"filename": "quarterly_report.pdf",
"mime_type": "application/pdf",
"size_bytes": 1048576,
"md5": "5d41402abc4b2a76b9719d911017c592",
"created_at": "2024-01-15T10:30:00Z",
"message_ids": [
"claude_chat_msg_abc123"
],
"claude_chat_ids": [
"claude_chat_def456"
]
}
```
## Delete file
**delete** `/v1/compliance/apps/chats/files/{claude_file_id}`
Permanently deletes a specific file. This is a destructive
operation that cannot be undone.
### Path Parameters
- `claude_file_id: string`
The file ID (tagged ID, e.g., claude_file_abc123)
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `id: string`
The ID of the file that was deleted
- `type: optional "claude_file_deleted"`
Constant string confirming deletion
- `"claude_file_deleted"`
### Example
```http
curl https://api.anthropic.com/v1/compliance/apps/chats/files/$CLAUDE_FILE_ID \
-X DELETE \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
#### Response
```json
{
"id": "claude_file_xyz789",
"type": "claude_file_deleted"
}
```
## Download file content
**get** `/v1/compliance/apps/chats/files/{claude_file_id}/content`
Downloads the binary content of a file referenced in chat messages.
### Path Parameters
- `claude_file_id: string`
The file ID (tagged ID, e.g., claude_file_abc123)
### Header Parameters
- `"x-api-key": optional string`
### Example
```http
curl https://api.anthropic.com/v1/compliance/apps/chats/files/$CLAUDE_FILE_ID/content \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
## Domain Types
### File Retrieve Response
- `FileRetrieveResponse object { id, claude_chat_ids, created_at, 5 more }`
File metadata for GET /v1/compliance/apps/chats/files/{claude_file_id}.
Returns metadata only. Use the sibling `/content` endpoint to download
the file bytes.
- `id: string`
File ID
- `claude_chat_ids: array of string`
Chats this file is attached to. A file can be referenced by messages across multiple chats.
- `created_at: string`
File creation timestamp
- `filename: string or null`
Display name of the file, if set
- `md5: string or null`
Lowercase hex MD5 of the file's preferred downloadable variant, as recorded at upload time. Null when no stored hash is available. The sibling `/content` endpoint also sets a `Content-MD5` header (base64 per RFC 1864) computed over the exact served bytes; when the two disagree, the header is authoritative.
- `message_ids: array of string`
Chat message IDs this file is 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 with no downloadable content (e.g. code-interpreter outputs).
- `size_bytes: number or null`
Size in bytes of the file's preferred downloadable variant, if known
### File Delete Response
- `FileDeleteResponse object { id, type }`
Response for deleting a compliance file.
- `id: string`
The ID of the file that was deleted
- `type: optional "claude_file_deleted"`
Constant string confirming deletion
- `"claude_file_deleted"`
api/compliance/apps/chats/files/delete First recorded · 50 lines, first recorded
## Delete file ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Delete file
url: https://platform.claude.com/docs/en/api/compliance/apps/chats/files/delete
---
## Delete file
**delete** `/v1/compliance/apps/chats/files/{claude_file_id}`
Permanently deletes a specific file. This is a destructive
operation that cannot be undone.
### Path Parameters
- `claude_file_id: string`
The file ID (tagged ID, e.g., claude_file_abc123)
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `id: string`
The ID of the file that was deleted
- `type: optional "claude_file_deleted"`
Constant string confirming deletion
- `"claude_file_deleted"`
### Example
```http
curl https://api.anthropic.com/v1/compliance/apps/chats/files/$CLAUDE_FILE_ID \
-X DELETE \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
#### Response
```json
{
"id": "claude_file_xyz789",
"type": "claude_file_deleted"
}
```
api/compliance/apps/chats/files/download First recorded · 27 lines, first recorded
## Download file content ### Path Parameters ### Header Parameters ### Example
The first capture of this source. The page was already there, and this is what it said.
---
title: Download file content
url: https://platform.claude.com/docs/en/api/compliance/apps/chats/files/download
---
## Download file content
**get** `/v1/compliance/apps/chats/files/{claude_file_id}/content`
Downloads the binary content of a file referenced in chat messages.
### Path Parameters
- `claude_file_id: string`
The file ID (tagged ID, e.g., claude_file_abc123)
### Header Parameters
- `"x-api-key": optional string`
### Example
```http
curl https://api.anthropic.com/v1/compliance/apps/chats/files/$CLAUDE_FILE_ID/content \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
api/compliance/apps/chats/files/retrieve First recorded · 82 lines, first recorded
## Get file metadata ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Get file metadata
url: https://platform.claude.com/docs/en/api/compliance/apps/chats/files/retrieve
---
## Get file metadata
**get** `/v1/compliance/apps/chats/files/{claude_file_id}`
Retrieves metadata for a file referenced in chat messages, without
downloading the file content. Use the sibling `/content` endpoint to
download the bytes.
### Path Parameters
- `claude_file_id: string`
The file ID (tagged ID, e.g., claude_file_abc123)
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `id: string`
File ID
- `claude_chat_ids: array of string`
Chats this file is attached to. A file can be referenced by messages across multiple chats.
- `created_at: string`
File creation timestamp
- `filename: string or null`
Display name of the file, if set
- `md5: string or null`
Lowercase hex MD5 of the file's preferred downloadable variant, as recorded at upload time. Null when no stored hash is available. The sibling `/content` endpoint also sets a `Content-MD5` header (base64 per RFC 1864) computed over the exact served bytes; when the two disagree, the header is authoritative.
- `message_ids: array of string`
Chat message IDs this file is 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 with no downloadable content (e.g. code-interpreter outputs).
- `size_bytes: number or null`
Size in bytes of the file's preferred downloadable variant, if known
### Example
```http
curl https://api.anthropic.com/v1/compliance/apps/chats/files/$CLAUDE_FILE_ID \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
#### Response
```json
{
"id": "claude_file_xyz789",
"filename": "quarterly_report.pdf",
"mime_type": "application/pdf",
"size_bytes": 1048576,
"md5": "5d41402abc4b2a76b9719d911017c592",
"created_at": "2024-01-15T10:30:00Z",
"message_ids": [
"claude_chat_msg_abc123"
],
"claude_chat_ids": [
"claude_chat_def456"
]
}
```
api/compliance/apps/chats/generated_files First recorded · 140 lines, first recorded
# Generated Files ## Get Claude-generated file metadata ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Download a Claude-generated file ### Path Parameters ### Header Parameters ### Example ## Domain Types ### Generated File Retrieve Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Generated Files
url: https://platform.claude.com/docs/en/api/compliance/apps/chats/generated_files
---
# Generated Files
## Get Claude-generated file metadata
**get** `/v1/compliance/apps/chats/generated-files/{claude_gen_file_id}`
Returns metadata for a file the assistant created via tool use.
Use the sibling `/content` endpoint to download the bytes.
### Path Parameters
- `claude_gen_file_id: string`
The generated-file id (e.g., 'claude_gen_file_abc123') as returned in `chat_messages[].generated_files[].id` from GET /apps/chats/{claude_chat_id}/messages.
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `id: string`
Opaque generated-file id, e.g. 'claude_gen_file_abc123'.
- `claude_chat_id: string`
The chat this generated file belongs to
- `created_at: string or null`
File creation timestamp, when available
- `filename: string`
Display name of the generated file
- `md5: string or null`
Lowercase hex MD5 of the stored file. Null when no stored hash is available. The sibling `/content` endpoint also sets a `Content-MD5` header (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 stored file, when available
### Example
```http
curl https://api.anthropic.com/v1/compliance/apps/chats/generated-files/$CLAUDE_GEN_FILE_ID \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
#### Response
```json
{
"id": "id",
"claude_chat_id": "claude_chat_id",
"created_at": "2019-12-27T18:11:19.117Z",
"filename": "filename",
"md5": "md5",
"mime_type": "mime_type",
"size_bytes": 0
}
```
## Download a Claude-generated file
**get** `/v1/compliance/apps/chats/generated-files/{claude_gen_file_id}/content`
Downloads the binary content of a file the assistant created via tool use.
### Path Parameters
- `claude_gen_file_id: string`
The generated-file id (e.g., 'claude_gen_file_abc123') as returned in `chat_messages[].generated_files[].id` from GET /apps/chats/{claude_chat_id}/messages.
### Header Parameters
- `"x-api-key": optional string`
### Example
```http
curl https://api.anthropic.com/v1/compliance/apps/chats/generated-files/$CLAUDE_GEN_FILE_ID/content \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
## Domain Types
### Generated File Retrieve Response
- `GeneratedFileRetrieveResponse object { id, claude_chat_id, created_at, 4 more }`
Metadata for GET /v1/compliance/apps/chats/generated-files/{claude_gen_file_id}.
Returns metadata only. Use the sibling `/content` endpoint to download
the bytes. The owning chat is included since the id is opaque; to find the
specific message that produced the file, fetch
`/v1/compliance/apps/chats/{claude_chat_id}/messages` and match on
`generated_files[].id`.
- `id: string`
Opaque generated-file id, e.g. 'claude_gen_file_abc123'.
- `claude_chat_id: string`
The chat this generated file belongs to
- `created_at: string or null`
File creation timestamp, when available
- `filename: string`
Display name of the generated file
- `md5: string or null`
Lowercase hex MD5 of the stored file. Null when no stored hash is available. The sibling `/content` endpoint also sets a `Content-MD5` header (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 stored file, when available
api/compliance/apps/chats/generated_files/download First recorded · 27 lines, first recorded
## Download a Claude-generated file ### Path Parameters ### Header Parameters ### Example
The first capture of this source. The page was already there, and this is what it said.
---
title: Download a Claude-generated file
url: https://platform.claude.com/docs/en/api/compliance/apps/chats/generated_files/download
---
## Download a Claude-generated file
**get** `/v1/compliance/apps/chats/generated-files/{claude_gen_file_id}/content`
Downloads the binary content of a file the assistant created via tool use.
### Path Parameters
- `claude_gen_file_id: string`
The generated-file id (e.g., 'claude_gen_file_abc123') as returned in `chat_messages[].generated_files[].id` from GET /apps/chats/{claude_chat_id}/messages.
### Header Parameters
- `"x-api-key": optional string`
### Example
```http
curl https://api.anthropic.com/v1/compliance/apps/chats/generated-files/$CLAUDE_GEN_FILE_ID/content \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
api/compliance/apps/chats/generated_files/retrieve First recorded · 73 lines, first recorded
## Get Claude-generated file metadata ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Get Claude-generated file metadata
url: https://platform.claude.com/docs/en/api/compliance/apps/chats/generated_files/retrieve
---
## Get Claude-generated file metadata
**get** `/v1/compliance/apps/chats/generated-files/{claude_gen_file_id}`
Returns metadata for a file the assistant created via tool use.
Use the sibling `/content` endpoint to download the bytes.
### Path Parameters
- `claude_gen_file_id: string`
The generated-file id (e.g., 'claude_gen_file_abc123') as returned in `chat_messages[].generated_files[].id` from GET /apps/chats/{claude_chat_id}/messages.
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `id: string`
Opaque generated-file id, e.g. 'claude_gen_file_abc123'.
- `claude_chat_id: string`
The chat this generated file belongs to
- `created_at: string or null`
File creation timestamp, when available
- `filename: string`
Display name of the generated file
- `md5: string or null`
Lowercase hex MD5 of the stored file. Null when no stored hash is available. The sibling `/content` endpoint also sets a `Content-MD5` header (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 stored file, when available
### Example
```http
curl https://api.anthropic.com/v1/compliance/apps/chats/generated-files/$CLAUDE_GEN_FILE_ID \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
#### Response
```json
{
"id": "id",
"claude_chat_id": "claude_chat_id",
"created_at": "2019-12-27T18:11:19.117Z",
"filename": "filename",
"md5": "md5",
"mime_type": "mime_type",
"size_bytes": 0
}
```
api/compliance/apps/chats/list First recorded · 190 lines, first recorded
## List chats ### Query Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: List chats
url: https://platform.claude.com/docs/en/api/compliance/apps/chats/list
---
## List chats
**get** `/v1/compliance/apps/chats`
Lists chat metadata with filtering capabilities for targeted
compliance review. Results are sorted chronologically (time ascending)
by the `order_by` key, with ties broken by id.
### Query Parameters
- `after_id: optional string`
Pagination cursor for retrieving the next page of results. To paginate, pass the `last_id` value from the most recent response. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
- `before_id: optional string`
Pagination cursor for retrieving the previous page of results. To paginate, pass the `first_id` value from the most recent response. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
- `created_at: optional object { gt, gte, lt, lte }`
- `gt: optional string`
Filter chats created after this time (RFC 3339 format)
- `gte: optional string`
Filter chats created at or after this time (RFC 3339 format)
- `lt: optional string`
Filter chats created before this time (RFC 3339 format)
- `lte: optional string`
Filter chats created at or before this time (RFC 3339 format)
- `limit: optional number`
Maximum results (default: 100, max: 1000)
- `order_by: optional "created_at" or "updated_at"`
Sort key for results. `created_at` (default) sorts by chat creation time. `updated_at` sorts by last update time and is only supported for org-wide queries (omit user_ids[]). For org-wide queries, any time filter must match the sort key: `created_at.*` filters require `order_by=created_at`, and `updated_at.*` filters require `order_by=updated_at`.
- `"created_at"`
- `"updated_at"`
- `organization_ids: optional array of string`
Filter by organization IDs (accepts `org_...` or organization UUID). Enumerate IDs via `GET /v1/compliance/organizations`.
- `project_ids: optional array of string`
Filter by project IDs (accepts `claude_proj_...`). Enumerate IDs via `GET /v1/compliance/apps/projects`. Requires user_ids[]; not supported for org-wide queries.
- `updated_at: optional object { gt, gte, lt, lte }`
- `gt: optional string`
Filter chats updated after this time (RFC 3339 format)
- `gte: optional string`
Filter chats updated at or after this time (RFC 3339 format)
- `lt: optional string`
Filter chats updated before this time (RFC 3339 format)
- `lte: optional string`
Filter chats updated at or before this time (RFC 3339 format)
- `user_ids: optional array of string`
Filter to chats created by specific users (max 10 per request). Omit for an org-wide query. Enumerate IDs via `GET /v1/compliance/organizations/{org_uuid}/users`.
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `data: array of object { id, created_at, deleted_at, 8 more }`
List of chat metadata sorted chronologically by the request's `order_by` key (default `created_at`), tie break by id
- `id: string`
Chat ID
- `created_at: string`
Creation timestamp
- `deleted_at: string or null`
Deletion timestamp if deleted
- `href: string`
URL to view this chat in claude.ai
- `model: string or null`
Model selected for this chat (e.g. 'claude-opus-4-7'). May be null for legacy chats that never had a model recorded.
- `name: string`
Chat name/title
- `organization_id: string`
Organization ID this chat belongs to
- `organization_uuid: string`
Organization UUID this chat belongs to
- `project_id: string or null`
Project ID this chat belongs to
- `updated_at: string`
Last update timestamp
- `user: object { id, email_address } or null`
User information for compliance responses.
- `id: string`
User identifier
- `email_address: string`
User's email address
- `first_id: string or null`
Opaque pagination cursor for the first chat in the current result set. Pass as `before_id` on the next request to page backwards. Backward pagination is only supported for per-user queries (`user_ids[]` set); org-wide queries do not accept `before_id`. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
- `has_more: boolean`
Whether more records exist beyond the current result set
- `last_id: string or null`
Opaque pagination cursor for the last chat in the current result set. Pass as `after_id` on the next request to page forwards. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
### Example
```http
curl https://api.anthropic.com/v1/compliance/apps/chats \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
#### Response
```json
{
"data": [
{
"id": "claude_chat_abc123",
"name": "Product Requirements Discussion",
"created_at": "2025-06-07T08:09:10Z",
"updated_at": "2025-06-07T09:10:11Z",
"organization_id": "org_abc123",
"organization_uuid": "abcdef0123-4567-89ab-cdef-0123456789ab",
"project_id": "claude_proj_xyz789",
"model": "claude-opus-4-7",
"user": {
"id": "user_xyz456",
"email_address": "[email protected]"
},
"href": "https://claude.ai/chat/abcdef01-2345-6789-abcd-ef0123456789"
}
],
"has_more": false,
"first_id": "eyJrIjogImNyZWF0ZWRfYXQiLCAidCI6ICIyMDI1LTA2LTA3VDA4OjA5OjEwKzAwOjAwIiwgImlkIjogImFiY2RlZjAxLTIzNDUtNjc4OS1hYmNkLWVmMDEyMzQ1Njc4OSJ9",
"last_id": "eyJrIjogImNyZWF0ZWRfYXQiLCAidCI6ICIyMDI1LTA2LTA3VDA4OjA5OjEwKzAwOjAwIiwgImlkIjogImFiY2RlZjAxLTIzNDUtNjc4OS1hYmNkLWVmMDEyMzQ1Njc4OSJ9"
}
```
api/compliance/apps/chats/messages First recorded · 614 lines, first recorded
# Messages ## Get chat messages ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Message List Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Messages
url: https://platform.claude.com/docs/en/api/compliance/apps/chats/messages
---
# Messages
## Get chat messages
**get** `/v1/compliance/apps/chats/{claude_chat_id}/messages`
Retrieves message history and file metadata for a specific chat.
### Path Parameters
- `claude_chat_id: string`
The chat ID (tagged ID, e.g., claude_chat_abc123)
### Query Parameters
- `after_id: optional string`
Pagination cursor for retrieving the next page of results. To paginate, pass the `last_id` value from the most recent response. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
- `before_id: optional string`
Pagination cursor for retrieving the previous page of results. To paginate, pass the `first_id` value from the most recent response. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
- `created_at: optional object { gt, gte, lt, lte }`
- `gt: optional string`
Filter messages created after this time (RFC 3339 format)
- `gte: optional string`
Filter messages created at or after this time (RFC 3339 format)
- `lt: optional string`
Filter messages created before this time (RFC 3339 format)
- `lte: optional string`
Filter messages created at or before this time (RFC 3339 format)
- `limit: optional number`
Maximum results (max: 1000). When omitted, the full result set is returned in one response.
- `order: optional "asc" or "desc"`
Sort direction for messages within the response. `asc` (the default) returns oldest-first; `desc` returns newest-first.
- `"asc"`
- `"desc"`
- `tool_result_max_chars: optional number`
Maximum characters returned per tool-result text item. Items longer than this are shortened and the block's `truncated` field is set. Pass -1 to disable the limit.
- `tool_use_input_max_chars: optional number`
Maximum characters of JSON-encoded tool input returned per tool_use block. Inputs longer than this are shortened and the block's `truncated` field is set. Pass -1 to disable the limit.
- `updated_at: optional object { gt, gte, lt, lte }`
- `gt: optional string`
Filter messages updated after this time (RFC 3339 format)
- `gte: optional string`
Filter messages updated at or after this time (RFC 3339 format)
- `lt: optional string`
Filter messages updated before this time (RFC 3339 format)
- `lte: optional string`
Filter messages updated at or before this time (RFC 3339 format)
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `id: string`
Chat ID
- `chat_messages: array of object { id, artifacts, content, 4 more }`
Array of chat messages in order of created_at
- `id: string`
Unique identifier for the message e.g. 'claude_chat_msg_abcd1234'
- `artifacts: array of object { id, artifact_type, title, version_id } or null`
Versioned documents generated or updated by the assistant in this message. Download via `GET /v1/compliance/apps/artifacts/{artifact_version_id}/content`.
- `id: string`
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`
Artifact title
- `version_id: string`
Artifact version ID e.g. 'claude_artifact_version_abc123'
- `content: array of object { text, thinking_redacted, truncated, type } or object { id, input, integration_name, 4 more } or object { content, integration_name, is_error, 5 more }`
Content blocks within the message
- `Text object { text, thinking_redacted, truncated, type }`
Text content block.
- `text: string`
Text content from human or assistant
- `thinking_redacted: boolean`
True when content enclosed in the assistant's internal-reasoning tags (or the tag markup itself) was removed from `text` during export. Removal never occurs with this field false. Always false on human messages, whose text is exported verbatim.
- `truncated: boolean`
True when `text` was shortened by the server's fixed per-string bound (1 MiB). Always false on chat text blocks.
- `type: "text"`
- `"text"`
- `ToolUse object { id, input, integration_name, 4 more }`
Tool invocation requested by the assistant.
- `id: string or null`
Tool-use ID, e.g. 'toolu_01AbC...'
- `input: string`
Arguments passed to the tool, as a JSON-encoded string. May be shortened — see the `truncated` field
- `integration_name: string or null`
Name of the integration that provides this tool, when applicable
- `mcp_server_url: string or null`
Base URL (scheme, host, and path only) of the MCP server that provides this tool, when applicable
- `name: string`
Name of the tool invoked
- `truncated: boolean`
True when `input` was shortened. Pass the endpoint's tool-use input max parameter as -1 to request full content, subject to any server-side maximum the endpoint enforces.
- `type: "tool_use"`
- `"tool_use"`
- `ToolResult object { content, integration_name, is_error, 5 more }`
Result returned by a tool invocation.
- `content: array of object { text, type }`
Text content returned by the tool. Generated files are surfaced via the message's `generated_files` list; other non-text item types (including images and links) are omitted.
- `text: string`
Text returned by the tool
- `type: "text"`
- `"text"`
- `integration_name: string or null`
Name of the integration that provides this tool, when applicable
- `is_error: boolean`
True when the tool reported an error
- `mcp_server_url: string or null`
Base URL (scheme, host, and path only) of the MCP server that provides this tool, when applicable
- `name: string`
Name of the tool that produced this result
- `tool_use_id: string or null`
ID of the tool_use block this result responds to
- `truncated: boolean`
True when one or more text items in `content` were shortened. Pass the endpoint's tool-result max parameter as -1 to request full content, subject to any server-side maximum the endpoint enforces.
- `type: "tool_result"`
- `"tool_result"`
- `created_at: string`
Message creation timestamp - For human: when they sent the message, For assistant: when it completed the last content block
- `files: array of object { id, created_at, filename, 3 more } or null`
Binary file attachments uploaded by the user. Download via `GET /v1/compliance/apps/chats/files/{claude_file_id}/content`.
- `id: string`
File ID
- `created_at: string`
File creation timestamp
- `filename: string`
Display name of the file
- `md5: string or null`
Lowercase hex MD5 of the file's preferred downloadable variant, as recorded at upload time. Null when no stored hash is available.
- `mime_type: string or null`
MIME type of the file's preferred downloadable variant (e.g. 'application/pdf')
- `size_bytes: number or null`
Size in bytes of the file's preferred downloadable variant, if known. Null for older files uploaded before size was recorded.
- `generated_files: array of object { id, filename, md5, 2 more } or null`
Downloadable files the assistant created via tool use (e.g. PDF, spreadsheet, slide deck). Distinct from `files`, which are uploads attached to the message. Download via `GET /v1/compliance/apps/chats/generated-files/{claude_gen_file_id}/content`.
- `id: string`
Opaque generated-file id, e.g. 'claude_gen_file_abc123'. Treat as an opaque string; the encoding may change without notice.
- `filename: string`
Display name of the generated file
- `md5: string or null`
Lowercase hex MD5 of the generated file, when available. Null when no stored hash is available.
- `mime_type: string or null`
MIME type reported by the tool that produced the file
- `size_bytes: number or null`
Size in bytes of the generated file, when available. Null when the file has expired or size is not recorded.
- `role: "assistant" or "user"`
Message sender (user or assistant)
- `"assistant"`
- `"user"`
- `created_at: string`
Creation timestamp
- `deleted_at: string or null`
Deletion timestamp if deleted
- `first_id: string or null`
Opaque pagination cursor for the first message in the current result set. Pass as `before_id` on the next request to page backwards. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
- `has_more: boolean`
Cut at 300 lines. The page has the rest.
api/compliance/apps/chats/messages/list First recorded · 416 lines, first recorded
## Get chat messages ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Get chat messages
url: https://platform.claude.com/docs/en/api/compliance/apps/chats/messages/list
---
## Get chat messages
**get** `/v1/compliance/apps/chats/{claude_chat_id}/messages`
Retrieves message history and file metadata for a specific chat.
### Path Parameters
- `claude_chat_id: string`
The chat ID (tagged ID, e.g., claude_chat_abc123)
### Query Parameters
- `after_id: optional string`
Pagination cursor for retrieving the next page of results. To paginate, pass the `last_id` value from the most recent response. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
- `before_id: optional string`
Pagination cursor for retrieving the previous page of results. To paginate, pass the `first_id` value from the most recent response. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
- `created_at: optional object { gt, gte, lt, lte }`
- `gt: optional string`
Filter messages created after this time (RFC 3339 format)
- `gte: optional string`
Filter messages created at or after this time (RFC 3339 format)
- `lt: optional string`
Filter messages created before this time (RFC 3339 format)
- `lte: optional string`
Filter messages created at or before this time (RFC 3339 format)
- `limit: optional number`
Maximum results (max: 1000). When omitted, the full result set is returned in one response.
- `order: optional "asc" or "desc"`
Sort direction for messages within the response. `asc` (the default) returns oldest-first; `desc` returns newest-first.
- `"asc"`
- `"desc"`
- `tool_result_max_chars: optional number`
Maximum characters returned per tool-result text item. Items longer than this are shortened and the block's `truncated` field is set. Pass -1 to disable the limit.
- `tool_use_input_max_chars: optional number`
Maximum characters of JSON-encoded tool input returned per tool_use block. Inputs longer than this are shortened and the block's `truncated` field is set. Pass -1 to disable the limit.
- `updated_at: optional object { gt, gte, lt, lte }`
- `gt: optional string`
Filter messages updated after this time (RFC 3339 format)
- `gte: optional string`
Filter messages updated at or after this time (RFC 3339 format)
- `lt: optional string`
Filter messages updated before this time (RFC 3339 format)
- `lte: optional string`
Filter messages updated at or before this time (RFC 3339 format)
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `id: string`
Chat ID
- `chat_messages: array of object { id, artifacts, content, 4 more }`
Array of chat messages in order of created_at
- `id: string`
Unique identifier for the message e.g. 'claude_chat_msg_abcd1234'
- `artifacts: array of object { id, artifact_type, title, version_id } or null`
Versioned documents generated or updated by the assistant in this message. Download via `GET /v1/compliance/apps/artifacts/{artifact_version_id}/content`.
- `id: string`
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`
Artifact title
- `version_id: string`
Artifact version ID e.g. 'claude_artifact_version_abc123'
- `content: array of object { text, thinking_redacted, truncated, type } or object { id, input, integration_name, 4 more } or object { content, integration_name, is_error, 5 more }`
Content blocks within the message
- `Text object { text, thinking_redacted, truncated, type }`
Text content block.
- `text: string`
Text content from human or assistant
- `thinking_redacted: boolean`
True when content enclosed in the assistant's internal-reasoning tags (or the tag markup itself) was removed from `text` during export. Removal never occurs with this field false. Always false on human messages, whose text is exported verbatim.
- `truncated: boolean`
True when `text` was shortened by the server's fixed per-string bound (1 MiB). Always false on chat text blocks.
- `type: "text"`
- `"text"`
- `ToolUse object { id, input, integration_name, 4 more }`
Tool invocation requested by the assistant.
- `id: string or null`
Tool-use ID, e.g. 'toolu_01AbC...'
- `input: string`
Arguments passed to the tool, as a JSON-encoded string. May be shortened — see the `truncated` field
- `integration_name: string or null`
Name of the integration that provides this tool, when applicable
- `mcp_server_url: string or null`
Base URL (scheme, host, and path only) of the MCP server that provides this tool, when applicable
- `name: string`
Name of the tool invoked
- `truncated: boolean`
True when `input` was shortened. Pass the endpoint's tool-use input max parameter as -1 to request full content, subject to any server-side maximum the endpoint enforces.
- `type: "tool_use"`
- `"tool_use"`
- `ToolResult object { content, integration_name, is_error, 5 more }`
Result returned by a tool invocation.
- `content: array of object { text, type }`
Text content returned by the tool. Generated files are surfaced via the message's `generated_files` list; other non-text item types (including images and links) are omitted.
- `text: string`
Text returned by the tool
- `type: "text"`
- `"text"`
- `integration_name: string or null`
Name of the integration that provides this tool, when applicable
- `is_error: boolean`
True when the tool reported an error
- `mcp_server_url: string or null`
Base URL (scheme, host, and path only) of the MCP server that provides this tool, when applicable
- `name: string`
Name of the tool that produced this result
- `tool_use_id: string or null`
ID of the tool_use block this result responds to
- `truncated: boolean`
True when one or more text items in `content` were shortened. Pass the endpoint's tool-result max parameter as -1 to request full content, subject to any server-side maximum the endpoint enforces.
- `type: "tool_result"`
- `"tool_result"`
- `created_at: string`
Message creation timestamp - For human: when they sent the message, For assistant: when it completed the last content block
- `files: array of object { id, created_at, filename, 3 more } or null`
Binary file attachments uploaded by the user. Download via `GET /v1/compliance/apps/chats/files/{claude_file_id}/content`.
- `id: string`
File ID
- `created_at: string`
File creation timestamp
- `filename: string`
Display name of the file
- `md5: string or null`
Lowercase hex MD5 of the file's preferred downloadable variant, as recorded at upload time. Null when no stored hash is available.
- `mime_type: string or null`
MIME type of the file's preferred downloadable variant (e.g. 'application/pdf')
- `size_bytes: number or null`
Size in bytes of the file's preferred downloadable variant, if known. Null for older files uploaded before size was recorded.
- `generated_files: array of object { id, filename, md5, 2 more } or null`
Downloadable files the assistant created via tool use (e.g. PDF, spreadsheet, slide deck). Distinct from `files`, which are uploads attached to the message. Download via `GET /v1/compliance/apps/chats/generated-files/{claude_gen_file_id}/content`.
- `id: string`
Opaque generated-file id, e.g. 'claude_gen_file_abc123'. Treat as an opaque string; the encoding may change without notice.
- `filename: string`
Display name of the generated file
- `md5: string or null`
Lowercase hex MD5 of the generated file, when available. Null when no stored hash is available.
- `mime_type: string or null`
MIME type reported by the tool that produced the file
- `size_bytes: number or null`
Size in bytes of the generated file, when available. Null when the file has expired or size is not recorded.
- `role: "assistant" or "user"`
Message sender (user or assistant)
- `"assistant"`
- `"user"`
- `created_at: string`
Creation timestamp
- `deleted_at: string or null`
Deletion timestamp if deleted
- `first_id: string or null`
Opaque pagination cursor for the first message in the current result set. Pass as `before_id` on the next request to page backwards. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
- `has_more: boolean`
Whether more chat messages exist beyond the current result set. Use `last_id` as `after_id` in a follow-up request to page forward.
Cut at 300 lines. The page has the rest.
api/compliance/apps/projects First recorded · 1335 lines, first recorded
# Projects ## List projects ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Get project details ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Delete project ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Project List Response ### Project Retrieve Response ### Project Delete Response # Attachments ## List project attachments ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Attachment List Response # Collaborators ## List project collaborators ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Collaborator List Response # Documents ## Get project document content ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Get project document metadata ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Delete project document ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Document Retrieve Response ### Document Metadata Response ### Document Delete Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Projects
url: https://platform.claude.com/docs/en/api/compliance/apps/projects
---
# Projects
## List projects
**get** `/v1/compliance/apps/projects`
Lists project metadata with filtering capabilities. Results
are sorted chronologically (time ascending) by created_at.
### Query Parameters
- `created_at: optional object { gt, gte, lt, lte }`
- `gt: optional string`
Filter projects created after this time (RFC 3339 format)
- `gte: optional string`
Filter projects created at or after this time (RFC 3339 format)
- `lt: optional string`
Filter projects created before this time (RFC 3339 format)
- `lte: optional string`
Filter projects created at or before this time (RFC 3339 format)
- `limit: optional number`
Maximum results (default: 20, max: 100)
- `organization_ids: optional array of string`
Filter by organization IDs (accepts `org_...` or organization UUID). Enumerate IDs via `GET /v1/compliance/organizations`.
- `page: optional string`
Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
- `updated_at: optional object { gt, gte, lt, lte }`
- `gt: optional string`
Filter projects updated after this time (RFC 3339 format)
- `gte: optional string`
Filter projects updated at or after this time (RFC 3339 format)
- `lt: optional string`
Filter projects updated before this time (RFC 3339 format)
- `lte: optional string`
Filter projects updated at or before this time (RFC 3339 format)
- `user_ids: optional array of string`
Filter by user IDs. Enumerate IDs via `GET /v1/compliance/organizations/{org_uuid}/users`.
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `data: array of object { id, created_at, deleted_at, 6 more }`
List of projects sorted by creation date ascending
- `id: string`
Project identifier (tagged ID)
- `created_at: string`
Project creation timestamp
- `deleted_at: string or null`
Timestamp when the project was deleted by an end user, or null otherwise
- `is_private: boolean`
If false, the project is visible to all organization members; if true the project is accessible only to the creator and specified collaborators
- `name: string`
Project name
- `organization_id: string`
Organization identifier (tagged ID)
- `organization_uuid: string`
Organization UUID this project belongs to
- `updated_at: string`
Project last update timestamp
- `user: object { id, email_address } or null`
The user who created a project or project document.
Fields that reference this type are null when the creator's account has
been deleted or the creator is no longer a member of an organization the
key may read.
- `id: string`
User identifier (tagged ID)
- `email_address: string`
User's email address
- `has_more: boolean`
Whether more records exist beyond the current result set
- `next_page: string or null`
Token to retrieve the next page. Use this as the 'page' parameter in your next request
### Example
```http
curl https://api.anthropic.com/v1/compliance/apps/projects \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
#### Response
```json
{
"data": [
{
"id": "claude_proj_abc123",
"name": "Q4 Product Planning",
"created_at": "2025-06-01T10:00:00Z",
"updated_at": "2025-06-15T14:30:00Z",
"is_private": true,
"organization_id": "org_abc123",
"organization_uuid": "abc12345-6789-0abc-def0-123456789abc",
"user": {
"id": "user_xyz456",
"email_address": "[email protected]"
}
}
],
"has_more": true,
"next_page": "page_eyJjcmVhdGVkX2F0IjoiMjAyNS0wNi0wMVQxMDowMDowMFoiLCJ1dWlkIjoiYWJjMTIzIn0="
}
```
## Get project details
**get** `/v1/compliance/apps/projects/{project_id}`
Get detailed information for a specific project.
### Path Parameters
- `project_id: string`
The project ID (tagged ID, e.g., claude_proj_abc123)
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `id: string`
Project identifier (tagged ID)
- `attachments_count: number`
Number of attachments contained within this project
- `chats_count: number`
Number of chats contained within this project
- `created_at: string`
Project creation timestamp
- `deleted_at: string or null`
Timestamp when the project was deleted by an end user, or null otherwise
- `description: string`
Project description
- `instructions: string`
Project's custom instructions / prompt
- `is_private: boolean`
If false, the project is visible to all organization members; if true the project is accessible only to the creator and specified collaborators
- `name: string`
Project name
- `organization_id: string`
Organization identifier (tagged ID)
- `organization_uuid: string`
Organization UUID this project belongs to
- `updated_at: string`
Project last update timestamp
- `user: object { id, email_address } or null`
The user who created a project or project document.
Fields that reference this type are null when the creator's account has
been deleted or the creator is no longer a member of an organization the
key may read.
- `id: string`
User identifier (tagged ID)
- `email_address: string`
User's email address
### Example
```http
curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
#### Response
```json
{
"id": "claude_proj_01Nm7PqRsTuVwXyZaBcDeFgH",
"attachments_count": 3,
"chats_count": 14,
"created_at": "2025-03-12T18:22:41.123456Z",
"deleted_at": "2019-12-27T18:11:19.117Z",
"description": "Planning and research for the Q3 launch",
"instructions": "Focus on concise, actionable answers.",
"is_private": true,
"name": "Q3 Product Launch",
"organization_id": "org_015eofRkKpogX7uDKUyvBTph",
"organization_uuid": "a1b2c3d4-e5f6-4789-a012-3456789abcde",
"updated_at": "2025-03-14T09:05:17.456789Z",
"user": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"email_address": "[email protected]"
}
}
```
## Delete project
**delete** `/v1/compliance/apps/projects/{project_id}`
Delete a project for compliance purposes.
Hard-deletes the project and all its associated data including:
- All project documents and files
- All role assignments
- Knowledge base (if RAG is enabled)
- Sync sources
Project must have no attached chats - returns 409 if chats exist.
### Path Parameters
- `project_id: string`
The project ID (tagged ID, e.g., claude_proj_abc123)
### Header Parameters
Cut at 300 lines. The page has the rest.
api/compliance/apps/projects/attachments First recorded · 222 lines, first recorded
# Attachments ## List project attachments ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Attachment List Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Attachments
url: https://platform.claude.com/docs/en/api/compliance/apps/projects/attachments
---
# Attachments
## List project attachments
**get** `/v1/compliance/apps/projects/{project_id}/attachments`
List files and documents attached to a project.
List files and project documents attached to the project referenced by project_id.
This includes the IDs of attached files, and attached project documents.
The raw binary content of attached files can be downloaded using the
GET /v1/compliance/apps/chats/files/{claude_file_id}/content endpoint.
The text content of attached project documents can be fetched using the
GET /v1/compliance/apps/projects/documents/{claude_proj_doc_id} endpoint.
### Path Parameters
- `project_id: string`
The project ID (tagged ID, e.g., claude_proj_abc123)
### Query Parameters
- `limit: optional number`
Maximum results (default: 20, max: 100)
- `page: optional string`
Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `data: array of object { id, created_at, filename, 4 more } or object { id, created_at, filename, 3 more }`
List of attachments sorted chronologically by created_at, tie break by id
- `ComplianceProjectFileReference object { id, created_at, filename, 4 more }`
File attachment reference for compliance responses.
- `id: string`
File identifier (e.g., 'claude_file_abcd')
- `created_at: string`
Creation timestamp (RFC 3339 format)
- `filename: string`
Display name of the file (e.g., 'document.pdf')
- `md5: string or null`
Lowercase hex MD5 of the file's preferred downloadable variant, when recorded. Null otherwise. Use the per-file `/metadata` endpoint for the authoritative value.
- `mime_type: string`
MIME type of the file's preferred downloadable variant when one is recorded, else 'application/octet-stream'. Use the per-file `/metadata` endpoint for the authoritative value.
- `size_bytes: number or null`
Size in bytes of the file's preferred downloadable variant, when recorded. Null otherwise. Use the per-file `/metadata` endpoint for the authoritative value.
- `type: "project_file"`
Discriminator marking this as a binary file
- `"project_file"`
- `ComplianceProjectDocReference object { id, created_at, filename, 3 more }`
Project document attachment reference for compliance responses.
- `id: string`
Project document identifier (e.g., 'claude_proj_doc_abcd')
- `created_at: string`
Creation timestamp (RFC 3339 format)
- `filename: string`
Display name of the document (e.g., 'document.txt')
- `mime_type: "text/plain"`
MIME type of the project document, always set to plain text
- `"text/plain"`
- `type: "project_doc"`
Discriminator marking this as a plain text document
- `"project_doc"`
- `updated_at: string or null`
Last-modified timestamp of the document. Reserved for future use — currently always null.
- `has_more: boolean`
Whether more records exist beyond the current result set
- `next_page: string or null`
To get the next page, use the 'next_page' from the current response as the 'page' in your next request
### Example
```http
curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID/attachments \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
#### Response
```json
{
"data": [
{
"id": "id",
"created_at": "2019-12-27T18:11:19.117Z",
"filename": "filename",
"md5": "md5",
"mime_type": "mime_type",
"size_bytes": 0,
"type": "project_file"
}
],
"has_more": true,
"next_page": "next_page"
}
```
## Domain Types
### Attachment List Response
- `AttachmentListResponse = object { id, created_at, filename, 4 more } or object { id, created_at, filename, 3 more }`
File attachment reference for compliance responses.
- `ComplianceProjectFileReference object { id, created_at, filename, 4 more }`
File attachment reference for compliance responses.
- `id: string`
File identifier (e.g., 'claude_file_abcd')
- `created_at: string`
Creation timestamp (RFC 3339 format)
- `filename: string`
Display name of the file (e.g., 'document.pdf')
- `md5: string or null`
Lowercase hex MD5 of the file's preferred downloadable variant, when recorded. Null otherwise. Use the per-file `/metadata` endpoint for the authoritative value.
- `mime_type: string`
MIME type of the file's preferred downloadable variant when one is recorded, else 'application/octet-stream'. Use the per-file `/metadata` endpoint for the authoritative value.
- `size_bytes: number or null`
Size in bytes of the file's preferred downloadable variant, when recorded. Null otherwise. Use the per-file `/metadata` endpoint for the authoritative value.
- `type: "project_file"`
Discriminator marking this as a binary file
- `"project_file"`
- `ComplianceProjectDocReference object { id, created_at, filename, 3 more }`
Project document attachment reference for compliance responses.
- `id: string`
Project document identifier (e.g., 'claude_proj_doc_abcd')
- `created_at: string`
Creation timestamp (RFC 3339 format)
- `filename: string`
Display name of the document (e.g., 'document.txt')
- `mime_type: "text/plain"`
MIME type of the project document, always set to plain text
- `"text/plain"`
- `type: "project_doc"`
Discriminator marking this as a plain text document
- `"project_doc"`
- `updated_at: string or null`
Last-modified timestamp of the document. Reserved for future use — currently always null.
api/compliance/apps/projects/attachments/list First recorded · 146 lines, first recorded
## List project attachments ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: List project attachments
url: https://platform.claude.com/docs/en/api/compliance/apps/projects/attachments/list
---
## List project attachments
**get** `/v1/compliance/apps/projects/{project_id}/attachments`
List files and documents attached to a project.
List files and project documents attached to the project referenced by project_id.
This includes the IDs of attached files, and attached project documents.
The raw binary content of attached files can be downloaded using the
GET /v1/compliance/apps/chats/files/{claude_file_id}/content endpoint.
The text content of attached project documents can be fetched using the
GET /v1/compliance/apps/projects/documents/{claude_proj_doc_id} endpoint.
### Path Parameters
- `project_id: string`
The project ID (tagged ID, e.g., claude_proj_abc123)
### Query Parameters
- `limit: optional number`
Maximum results (default: 20, max: 100)
- `page: optional string`
Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `data: array of object { id, created_at, filename, 4 more } or object { id, created_at, filename, 3 more }`
List of attachments sorted chronologically by created_at, tie break by id
- `ComplianceProjectFileReference object { id, created_at, filename, 4 more }`
File attachment reference for compliance responses.
- `id: string`
File identifier (e.g., 'claude_file_abcd')
- `created_at: string`
Creation timestamp (RFC 3339 format)
- `filename: string`
Display name of the file (e.g., 'document.pdf')
- `md5: string or null`
Lowercase hex MD5 of the file's preferred downloadable variant, when recorded. Null otherwise. Use the per-file `/metadata` endpoint for the authoritative value.
- `mime_type: string`
MIME type of the file's preferred downloadable variant when one is recorded, else 'application/octet-stream'. Use the per-file `/metadata` endpoint for the authoritative value.
- `size_bytes: number or null`
Size in bytes of the file's preferred downloadable variant, when recorded. Null otherwise. Use the per-file `/metadata` endpoint for the authoritative value.
- `type: "project_file"`
Discriminator marking this as a binary file
- `"project_file"`
- `ComplianceProjectDocReference object { id, created_at, filename, 3 more }`
Project document attachment reference for compliance responses.
- `id: string`
Project document identifier (e.g., 'claude_proj_doc_abcd')
- `created_at: string`
Creation timestamp (RFC 3339 format)
- `filename: string`
Display name of the document (e.g., 'document.txt')
- `mime_type: "text/plain"`
MIME type of the project document, always set to plain text
- `"text/plain"`
- `type: "project_doc"`
Discriminator marking this as a plain text document
- `"project_doc"`
- `updated_at: string or null`
Last-modified timestamp of the document. Reserved for future use — currently always null.
- `has_more: boolean`
Whether more records exist beyond the current result set
- `next_page: string or null`
To get the next page, use the 'next_page' from the current response as the 'page' in your next request
### Example
```http
curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID/attachments \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
#### Response
```json
{
"data": [
{
"id": "id",
"created_at": "2019-12-27T18:11:19.117Z",
"filename": "filename",
"md5": "md5",
"mime_type": "mime_type",
"size_bytes": 0,
"type": "project_file"
}
],
"has_more": true,
"next_page": "next_page"
}
```
api/compliance/apps/projects/collaborators First recorded · 323 lines, first recorded
# Collaborators ## List project collaborators ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Collaborator List Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Collaborators
url: https://platform.claude.com/docs/en/api/compliance/apps/projects/collaborators
---
# Collaborators
## List project collaborators
**get** `/v1/compliance/apps/projects/{project_id}/collaborators`
List the users, groups, and organization-wide grants on a project.
Each entry represents one active role assignment 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 Parameters
- `project_id: string`
The project ID (tagged ID, e.g., claude_proj_abc123)
### Query Parameters
- `limit: optional number`
Maximum results (default: 20, max: 100)
- `page: optional string`
Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `data: array of object { granted_at, role, type, user_id } or object { granted_at, group_id, role, type } or object { granted_at, organization_uuid, role, type } or object { granted_at, organization_role, role, type }`
List of collaborators sorted chronologically by granted_at, tie break by the underlying role-assignment UUID
- `ComplianceProjectUserCollaborator object { granted_at, role, type, user_id }`
An individual user granted a role on a project.
- `granted_at: string`
When this collaborator was granted access (RFC 3339 format)
- `role: "admin" or "editor" or "owner" or "viewer"`
Role granted on the project
- `"admin"`
- `"editor"`
- `"owner"`
- `"viewer"`
- `type: "user"`
Discriminator marking this as an individual user collaborator
- `"user"`
- `user_id: string or null`
Identifier of the user granted access (tagged ID), or null if their account has since been deleted
- `ComplianceProjectGroupCollaborator object { granted_at, group_id, role, type }`
An RBAC group granted a role on a project.
- `granted_at: string`
When this collaborator was granted access (RFC 3339 format)
- `group_id: string`
Identifier of the group granted access (tagged ID)
- `role: "admin" or "editor" or "owner" or "viewer"`
Role granted on the project
- `"admin"`
- `"editor"`
- `"owner"`
- `"viewer"`
- `type: "group"`
Discriminator marking this as a group collaborator
- `"group"`
- `ComplianceProjectOrganizationCollaborator object { granted_at, organization_uuid, role, type }`
An entire organization granted a role on a project.
- `granted_at: string`
When this collaborator was granted access (RFC 3339 format)
- `organization_uuid: string`
UUID of the organization granted access
- `role: "admin" or "editor" or "owner" or "viewer"`
Role granted on the project
- `"admin"`
- `"editor"`
- `"owner"`
- `"viewer"`
- `type: "organization"`
Discriminator marking this as an organization-wide grant
- `"organization"`
- `ComplianceProjectOrganizationRoleCollaborator object { granted_at, organization_role, role, type }`
All holders of an organization-level role granted a role on a project.
- `granted_at: string`
When this collaborator was granted access (RFC 3339 format)
- `organization_role: string`
The organization-level role whose holders are granted access
- `role: "admin" or "editor" or "owner" or "viewer"`
Role granted on the project
- `"admin"`
- `"editor"`
- `"owner"`
- `"viewer"`
- `type: "organization_role"`
Discriminator marking this as a grant to all organization members holding a specific org-level role
- `"organization_role"`
- `has_more: boolean`
Whether more records exist beyond the current result set
- `next_page: string or null`
To get the next page, use the 'next_page' from the current response as the 'page' in your next request
### Example
```http
curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID/collaborators \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
#### Response
```json
{
"data": [
{
"granted_at": "2019-12-27T18:11:19.117Z",
"role": "admin",
"type": "user",
"user_id": "user_id"
}
],
"has_more": true,
"next_page": "next_page"
}
```
## Domain Types
### Collaborator List Response
- `CollaboratorListResponse = object { granted_at, role, type, user_id } or object { granted_at, group_id, role, type } or object { granted_at, organization_uuid, role, type } or object { granted_at, organization_role, role, type }`
An individual user granted a role on a project.
- `ComplianceProjectUserCollaborator object { granted_at, role, type, user_id }`
An individual user granted a role on a project.
- `granted_at: string`
When this collaborator was granted access (RFC 3339 format)
- `role: "admin" or "editor" or "owner" or "viewer"`
Role granted on the project
- `"admin"`
- `"editor"`
- `"owner"`
- `"viewer"`
- `type: "user"`
Discriminator marking this as an individual user collaborator
- `"user"`
- `user_id: string or null`
Identifier of the user granted access (tagged ID), or null if their account has since been deleted
- `ComplianceProjectGroupCollaborator object { granted_at, group_id, role, type }`
An RBAC group granted a role on a project.
- `granted_at: string`
When this collaborator was granted access (RFC 3339 format)
- `group_id: string`
Identifier of the group granted access (tagged ID)
- `role: "admin" or "editor" or "owner" or "viewer"`
Role granted on the project
- `"admin"`
- `"editor"`
- `"owner"`
- `"viewer"`
- `type: "group"`
Discriminator marking this as a group collaborator
- `"group"`
- `ComplianceProjectOrganizationCollaborator object { granted_at, organization_uuid, role, type }`
An entire organization granted a role on a project.
- `granted_at: string`
When this collaborator was granted access (RFC 3339 format)
- `organization_uuid: string`
UUID of the organization granted access
- `role: "admin" or "editor" or "owner" or "viewer"`
Role granted on the project
- `"admin"`
- `"editor"`
- `"owner"`
- `"viewer"`
- `type: "organization"`
Discriminator marking this as an organization-wide grant
- `"organization"`
- `ComplianceProjectOrganizationRoleCollaborator object { granted_at, organization_role, role, type }`
All holders of an organization-level role granted a role on a project.
- `granted_at: string`
Cut at 300 lines. The page has the rest.
api/compliance/apps/projects/collaborators/list First recorded · 193 lines, first recorded
## List project collaborators ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: List project collaborators
url: https://platform.claude.com/docs/en/api/compliance/apps/projects/collaborators/list
---
## List project collaborators
**get** `/v1/compliance/apps/projects/{project_id}/collaborators`
List the users, groups, and organization-wide grants on a project.
Each entry represents one active role assignment 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 Parameters
- `project_id: string`
The project ID (tagged ID, e.g., claude_proj_abc123)
### Query Parameters
- `limit: optional number`
Maximum results (default: 20, max: 100)
- `page: optional string`
Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `data: array of object { granted_at, role, type, user_id } or object { granted_at, group_id, role, type } or object { granted_at, organization_uuid, role, type } or object { granted_at, organization_role, role, type }`
List of collaborators sorted chronologically by granted_at, tie break by the underlying role-assignment UUID
- `ComplianceProjectUserCollaborator object { granted_at, role, type, user_id }`
An individual user granted a role on a project.
- `granted_at: string`
When this collaborator was granted access (RFC 3339 format)
- `role: "admin" or "editor" or "owner" or "viewer"`
Role granted on the project
- `"admin"`
- `"editor"`
- `"owner"`
- `"viewer"`
- `type: "user"`
Discriminator marking this as an individual user collaborator
- `"user"`
- `user_id: string or null`
Identifier of the user granted access (tagged ID), or null if their account has since been deleted
- `ComplianceProjectGroupCollaborator object { granted_at, group_id, role, type }`
An RBAC group granted a role on a project.
- `granted_at: string`
When this collaborator was granted access (RFC 3339 format)
- `group_id: string`
Identifier of the group granted access (tagged ID)
- `role: "admin" or "editor" or "owner" or "viewer"`
Role granted on the project
- `"admin"`
- `"editor"`
- `"owner"`
- `"viewer"`
- `type: "group"`
Discriminator marking this as a group collaborator
- `"group"`
- `ComplianceProjectOrganizationCollaborator object { granted_at, organization_uuid, role, type }`
An entire organization granted a role on a project.
- `granted_at: string`
When this collaborator was granted access (RFC 3339 format)
- `organization_uuid: string`
UUID of the organization granted access
- `role: "admin" or "editor" or "owner" or "viewer"`
Role granted on the project
- `"admin"`
- `"editor"`
- `"owner"`
- `"viewer"`
- `type: "organization"`
Discriminator marking this as an organization-wide grant
- `"organization"`
- `ComplianceProjectOrganizationRoleCollaborator object { granted_at, organization_role, role, type }`
All holders of an organization-level role granted a role on a project.
- `granted_at: string`
When this collaborator was granted access (RFC 3339 format)
- `organization_role: string`
The organization-level role whose holders are granted access
- `role: "admin" or "editor" or "owner" or "viewer"`
Role granted on the project
- `"admin"`
- `"editor"`
- `"owner"`
- `"viewer"`
- `type: "organization_role"`
Discriminator marking this as a grant to all organization members holding a specific org-level role
- `"organization_role"`
- `has_more: boolean`
Whether more records exist beyond the current result set
- `next_page: string or null`
To get the next page, use the 'next_page' from the current response as the 'page' in your next request
### Example
```http
curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID/collaborators \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
#### Response
```json
{
"data": [
{
"granted_at": "2019-12-27T18:11:19.117Z",
"role": "admin",
"type": "user",
"user_id": "user_id"
}
],
"has_more": true,
"next_page": "next_page"
}
```
api/compliance/apps/projects/delete First recorded · 58 lines, first recorded
## Delete project ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Delete project
url: https://platform.claude.com/docs/en/api/compliance/apps/projects/delete
---
## Delete project
**delete** `/v1/compliance/apps/projects/{project_id}`
Delete a project for compliance purposes.
Hard-deletes the project and all its associated data including:
- All project documents and files
- All role assignments
- Knowledge base (if RAG is enabled)
- Sync sources
Project must have no attached chats - returns 409 if chats exist.
### Path Parameters
- `project_id: string`
The project ID (tagged ID, e.g., claude_proj_abc123)
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `id: string`
The ID of the Claude project that was deleted
- `type: optional "claude_project_deleted"`
Constant string confirming deletion.
- `"claude_project_deleted"`
### Example
```http
curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID \
-X DELETE \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
#### Response
```json
{
"id": "id",
"type": "claude_project_deleted"
}
```
api/compliance/apps/projects/documents First recorded · 330 lines, first recorded
# Documents ## Get project document content ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Get project document metadata ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Delete project document ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Document Retrieve Response ### Document Metadata Response ### Document Delete Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Documents
url: https://platform.claude.com/docs/en/api/compliance/apps/projects/documents
---
# Documents
## Get project document content
**get** `/v1/compliance/apps/projects/documents/{document_id}`
Get detailed information for a specific project document.
### Path Parameters
- `document_id: string`
The document ID (tagged ID, e.g., claude_proj_doc_abc123)
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `id: string`
Project document identifier (tagged ID)
- `content: string`
Document text content
- `created_at: string`
Document creation timestamp
- `filename: string`
Document filename
- `user: object { id, email_address } or null`
The user who created a project or project document.
Fields that reference this type are null when the creator's account has
been deleted or the creator is no longer a member of an organization the
key may read.
- `id: string`
User identifier (tagged ID)
- `email_address: string`
User's email address
### Example
```http
curl https://api.anthropic.com/v1/compliance/apps/projects/documents/$DOCUMENT_ID \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
#### Response
```json
{
"id": "claude_proj_doc_01Qr8StUvWxYzAbCdEfGhJjK",
"content": "# Design notes\n\n- Item one\n- Item two\n",
"created_at": "2025-03-12T18:22:41.123456Z",
"filename": "design-notes.txt",
"user": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"email_address": "[email protected]"
}
}
```
## Get project document metadata
**get** `/v1/compliance/apps/projects/documents/{document_id}/metadata`
Returns metadata for a project document, without the content body.
Use the sibling `GET /v1/compliance/apps/projects/documents/{document_id}`
endpoint to fetch the document text. The `md5` and `size_bytes`
fields here are computed over the UTF-8 encoding of that text, so a DLP
consumer can dedupe or match hashes without downloading every document.
### Path Parameters
- `document_id: string`
The document ID (tagged ID, e.g., claude_proj_doc_abc123)
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `id: string`
Project document identifier (tagged ID)
- `claude_project_id: string`
The project this document belongs to
- `created_at: string`
Document creation timestamp
- `filename: string`
Document filename
- `md5: string`
Lowercase hex MD5 of the document content (UTF-8 encoded). Matches the `content` field returned by the sibling content endpoint.
- `mime_type: "text/plain"`
MIME type of the document content, always plain text
- `"text/plain"`
- `size_bytes: number`
Size in bytes of the document content (UTF-8 encoded)
- `user: object { id, email_address } or null`
The user who created a project or project document.
Fields that reference this type are null when the creator's account has
been deleted or the creator is no longer a member of an organization the
key may read.
- `id: string`
User identifier (tagged ID)
- `email_address: string`
User's email address
### Example
```http
curl https://api.anthropic.com/v1/compliance/apps/projects/documents/$DOCUMENT_ID/metadata \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
#### Response
```json
{
"id": "id",
"claude_project_id": "claude_project_id",
"created_at": "2019-12-27T18:11:19.117Z",
"filename": "filename",
"md5": "md5",
"mime_type": "text/plain",
"size_bytes": 0,
"user": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"email_address": "[email protected]"
}
}
```
## Delete project document
**delete** `/v1/compliance/apps/projects/documents/{document_id}`
Delete a project document for compliance purposes.
Hard-deletes the project document permanently.
### Path Parameters
- `document_id: string`
The document ID (tagged ID, e.g., claude_proj_doc_abc123)
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `id: string`
The ID of the project document that was deleted
- `type: "claude_project_document_deleted"`
Constant string confirming deletion.
- `"claude_project_document_deleted"`
### Example
```http
curl https://api.anthropic.com/v1/compliance/apps/projects/documents/$DOCUMENT_ID \
-X DELETE \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
#### Response
```json
{
"id": "id",
"type": "claude_project_document_deleted"
}
```
## Domain Types
### Document Retrieve Response
- `DocumentRetrieveResponse object { id, content, created_at, 2 more }`
Project document information for compliance responses.
- `id: string`
Project document identifier (tagged ID)
- `content: string`
Document text content
- `created_at: string`
Document creation timestamp
- `filename: string`
Document filename
- `user: object { id, email_address } or null`
The user who created a project or project document.
Fields that reference this type are null when the creator's account has
been deleted or the creator is no longer a member of an organization the
key may read.
- `id: string`
User identifier (tagged ID)
- `email_address: string`
User's email address
### Document Metadata Response
- `DocumentMetadataResponse object { id, claude_project_id, created_at, 5 more }`
Project document metadata for GET /v1/compliance/apps/projects/documents/{document_id}/metadata.
Returns metadata only. Use the sibling endpoint (without `/metadata`)
to fetch the document text content.
- `id: string`
Project document identifier (tagged ID)
- `claude_project_id: string`
The project this document belongs to
- `created_at: string`
Document creation timestamp
- `filename: string`
Document filename
- `md5: string`
Lowercase hex MD5 of the document content (UTF-8 encoded). Matches the `content` field returned by the sibling content endpoint.
- `mime_type: "text/plain"`
MIME type of the document content, always plain text
- `"text/plain"`
- `size_bytes: number`
Size in bytes of the document content (UTF-8 encoded)
- `user: object { id, email_address } or null`
Cut at 300 lines. The page has the rest.
api/compliance/apps/projects/documents/delete First recorded · 51 lines, first recorded
## Delete project document ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Delete project document
url: https://platform.claude.com/docs/en/api/compliance/apps/projects/documents/delete
---
## Delete project document
**delete** `/v1/compliance/apps/projects/documents/{document_id}`
Delete a project document for compliance purposes.
Hard-deletes the project document permanently.
### Path Parameters
- `document_id: string`
The document ID (tagged ID, e.g., claude_proj_doc_abc123)
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `id: string`
The ID of the project document that was deleted
- `type: "claude_project_document_deleted"`
Constant string confirming deletion.
- `"claude_project_document_deleted"`
### Example
```http
curl https://api.anthropic.com/v1/compliance/apps/projects/documents/$DOCUMENT_ID \
-X DELETE \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
#### Response
```json
{
"id": "id",
"type": "claude_project_document_deleted"
}
```
api/compliance/apps/projects/documents/metadata First recorded · 98 lines, first recorded
## Get project document metadata ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Get project document metadata
url: https://platform.claude.com/docs/en/api/compliance/apps/projects/documents/metadata
---
## Get project document metadata
**get** `/v1/compliance/apps/projects/documents/{document_id}/metadata`
Returns metadata for a project document, without the content body.
Use the sibling `GET /v1/compliance/apps/projects/documents/{document_id}`
endpoint to fetch the document text. The `md5` and `size_bytes`
fields here are computed over the UTF-8 encoding of that text, so a DLP
consumer can dedupe or match hashes without downloading every document.
### Path Parameters
- `document_id: string`
The document ID (tagged ID, e.g., claude_proj_doc_abc123)
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `id: string`
Project document identifier (tagged ID)
- `claude_project_id: string`
The project this document belongs to
- `created_at: string`
Document creation timestamp
- `filename: string`
Document filename
- `md5: string`
Lowercase hex MD5 of the document content (UTF-8 encoded). Matches the `content` field returned by the sibling content endpoint.
- `mime_type: "text/plain"`
MIME type of the document content, always plain text
- `"text/plain"`
- `size_bytes: number`
Size in bytes of the document content (UTF-8 encoded)
- `user: object { id, email_address } or null`
The user who created a project or project document.
Fields that reference this type are null when the creator's account has
been deleted or the creator is no longer a member of an organization the
key may read.
- `id: string`
User identifier (tagged ID)
- `email_address: string`
User's email address
### Example
```http
curl https://api.anthropic.com/v1/compliance/apps/projects/documents/$DOCUMENT_ID/metadata \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
#### Response
```json
{
"id": "id",
"claude_project_id": "claude_project_id",
"created_at": "2019-12-27T18:11:19.117Z",
"filename": "filename",
"md5": "md5",
"mime_type": "text/plain",
"size_bytes": 0,
"user": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"email_address": "[email protected]"
}
}
```
api/compliance/apps/projects/documents/retrieve First recorded · 76 lines, first recorded
## Get project document content ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Get project document content
url: https://platform.claude.com/docs/en/api/compliance/apps/projects/documents/retrieve
---
## Get project document content
**get** `/v1/compliance/apps/projects/documents/{document_id}`
Get detailed information for a specific project document.
### Path Parameters
- `document_id: string`
The document ID (tagged ID, e.g., claude_proj_doc_abc123)
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `id: string`
Project document identifier (tagged ID)
- `content: string`
Document text content
- `created_at: string`
Document creation timestamp
- `filename: string`
Document filename
- `user: object { id, email_address } or null`
The user who created a project or project document.
Fields that reference this type are null when the creator's account has
been deleted or the creator is no longer a member of an organization the
key may read.
- `id: string`
User identifier (tagged ID)
- `email_address: string`
User's email address
### Example
```http
curl https://api.anthropic.com/v1/compliance/apps/projects/documents/$DOCUMENT_ID \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
#### Response
```json
{
"id": "claude_proj_doc_01Qr8StUvWxYzAbCdEfGhJjK",
"content": "# Design notes\n\n- Item one\n- Item two\n",
"created_at": "2025-03-12T18:22:41.123456Z",
"filename": "design-notes.txt",
"user": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"email_address": "[email protected]"
}
}
```
api/compliance/apps/projects/list First recorded · 162 lines, first recorded
## List projects ### Query Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: List projects
url: https://platform.claude.com/docs/en/api/compliance/apps/projects/list
---
## List projects
**get** `/v1/compliance/apps/projects`
Lists project metadata with filtering capabilities. Results
are sorted chronologically (time ascending) by created_at.
### Query Parameters
- `created_at: optional object { gt, gte, lt, lte }`
- `gt: optional string`
Filter projects created after this time (RFC 3339 format)
- `gte: optional string`
Filter projects created at or after this time (RFC 3339 format)
- `lt: optional string`
Filter projects created before this time (RFC 3339 format)
- `lte: optional string`
Filter projects created at or before this time (RFC 3339 format)
- `limit: optional number`
Maximum results (default: 20, max: 100)
- `organization_ids: optional array of string`
Filter by organization IDs (accepts `org_...` or organization UUID). Enumerate IDs via `GET /v1/compliance/organizations`.
- `page: optional string`
Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
- `updated_at: optional object { gt, gte, lt, lte }`
- `gt: optional string`
Filter projects updated after this time (RFC 3339 format)
- `gte: optional string`
Filter projects updated at or after this time (RFC 3339 format)
- `lt: optional string`
Filter projects updated before this time (RFC 3339 format)
- `lte: optional string`
Filter projects updated at or before this time (RFC 3339 format)
- `user_ids: optional array of string`
Filter by user IDs. Enumerate IDs via `GET /v1/compliance/organizations/{org_uuid}/users`.
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `data: array of object { id, created_at, deleted_at, 6 more }`
List of projects sorted by creation date ascending
- `id: string`
Project identifier (tagged ID)
- `created_at: string`
Project creation timestamp
- `deleted_at: string or null`
Timestamp when the project was deleted by an end user, or null otherwise
- `is_private: boolean`
If false, the project is visible to all organization members; if true the project is accessible only to the creator and specified collaborators
- `name: string`
Project name
- `organization_id: string`
Organization identifier (tagged ID)
- `organization_uuid: string`
Organization UUID this project belongs to
- `updated_at: string`
Project last update timestamp
- `user: object { id, email_address } or null`
The user who created a project or project document.
Fields that reference this type are null when the creator's account has
been deleted or the creator is no longer a member of an organization the
key may read.
- `id: string`
User identifier (tagged ID)
- `email_address: string`
User's email address
- `has_more: boolean`
Whether more records exist beyond the current result set
- `next_page: string or null`
Token to retrieve the next page. Use this as the 'page' parameter in your next request
### Example
```http
curl https://api.anthropic.com/v1/compliance/apps/projects \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
#### Response
```json
{
"data": [
{
"id": "claude_proj_abc123",
"name": "Q4 Product Planning",
"created_at": "2025-06-01T10:00:00Z",
"updated_at": "2025-06-15T14:30:00Z",
"is_private": true,
"organization_id": "org_abc123",
"organization_uuid": "abc12345-6789-0abc-def0-123456789abc",
"user": {
"id": "user_xyz456",
"email_address": "[email protected]"
}
}
],
"has_more": true,
"next_page": "page_eyJjcmVhdGVkX2F0IjoiMjAyNS0wNi0wMVQxMDowMDowMFoiLCJ1dWlkIjoiYWJjMTIzIn0="
}
```
api/compliance/apps/projects/retrieve First recorded · 116 lines, first recorded
## Get project details ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Get project details
url: https://platform.claude.com/docs/en/api/compliance/apps/projects/retrieve
---
## Get project details
**get** `/v1/compliance/apps/projects/{project_id}`
Get detailed information for a specific project.
### Path Parameters
- `project_id: string`
The project ID (tagged ID, e.g., claude_proj_abc123)
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `id: string`
Project identifier (tagged ID)
- `attachments_count: number`
Number of attachments contained within this project
- `chats_count: number`
Number of chats contained within this project
- `created_at: string`
Project creation timestamp
- `deleted_at: string or null`
Timestamp when the project was deleted by an end user, or null otherwise
- `description: string`
Project description
- `instructions: string`
Project's custom instructions / prompt
- `is_private: boolean`
If false, the project is visible to all organization members; if true the project is accessible only to the creator and specified collaborators
- `name: string`
Project name
- `organization_id: string`
Organization identifier (tagged ID)
- `organization_uuid: string`
Organization UUID this project belongs to
- `updated_at: string`
Project last update timestamp
- `user: object { id, email_address } or null`
The user who created a project or project document.
Fields that reference this type are null when the creator's account has
been deleted or the creator is no longer a member of an organization the
key may read.
- `id: string`
User identifier (tagged ID)
- `email_address: string`
User's email address
### Example
```http
curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
#### Response
```json
{
"id": "claude_proj_01Nm7PqRsTuVwXyZaBcDeFgH",
"attachments_count": 3,
"chats_count": 14,
"created_at": "2025-03-12T18:22:41.123456Z",
"deleted_at": "2019-12-27T18:11:19.117Z",
"description": "Planning and research for the Q3 launch",
"instructions": "Focus on concise, actionable answers.",
"is_private": true,
"name": "Q3 Product Launch",
"organization_id": "org_015eofRkKpogX7uDKUyvBTph",
"organization_uuid": "a1b2c3d4-e5f6-4789-a012-3456789abcde",
"updated_at": "2025-03-14T09:05:17.456789Z",
"user": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"email_address": "[email protected]"
}
}
```
api/compliance/apps/sessions First recorded · 1353 lines, first recorded
# Sessions # Local ## List local sessions ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Retrieve a local session ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Local List Response ### Local Retrieve Response # Messages ## Retrieve local session messages ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Message List Response # Remote ## List remote sessions ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Remote List Response # Messages ## Retrieve remote session messages ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Message List Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Sessions
url: https://platform.claude.com/docs/en/api/compliance/apps/sessions
---
# Sessions
# Local
## List local sessions
**get** `/v1/compliance/apps/sessions/local`
List local sessions across the organizations the key may read.
Results are ordered by `created_at` descending. Pagination is
forward-only via `next_page`; there is no reverse cursor.
### Query Parameters
- `created_at: optional object { gte, lt }`
- `gte: optional string`
Only return sessions whose first inference call is at or after this time (RFC 3339; a UTC offset is required).
- `lt: optional string`
Only return sessions whose first inference call is strictly before this time (RFC 3339; a UTC offset is required).
- `limit: optional number`
Maximum results (default: 100, max: 500)
- `page: optional string`
Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `data: array of object { id, created_at, organization_uuid, 4 more }`
Page of local sessions, ordered by `created_at` descending; ties are broken by a fixed server-side order.
- `id: string`
Local session identifier, prefixed `clls_`. Unique within the parent organization. Treat as an opaque string; the format may change without notice.
- `created_at: string`
Timestamp of the session's first retained inference call (RFC 3339, UTC). When a session's activity spans the child organization's retention boundary, calls older than the boundary are no longer reflected, so this value is the timestamp of the earliest retained call: always strictly after the boundary, never the boundary itself.
- `organization_uuid: string`
UUID of the child organization the session belongs to
- `product_surface: string or null`
The product the session ran in: `cowork` for Cowork sessions in Claude Desktop, or `claude_code` for Claude Code sessions. New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded.
- `type: "compliance_local_session"`
- `"compliance_local_session"`
- `user: object { id, email_address }`
The authenticated user at the time of the session. Always set; `user.id` is always populated. `user.email_address` is null when the user's account has been deleted or the user is no longer a member of an organization the key may read.
- `id: string`
User identifier (tagged ID, prefixed `user_`). Always set, so attribution survives after the user's account is deleted or the user leaves the organizations the key may read.
- `email_address: string or null`
User's email address. Null when the user's account has been deleted or the user is no longer a member of an organization the key may read. The messages endpoint does not resolve email addresses; this field is always null there.
- `workspace_id: string or null`
Workspace identifier (tagged ID, prefixed `wrkspc_`). Null for sessions not attributed to a workspace.
- `next_page: string or null`
Opaque pagination cursor (prefixed `page_`) for the next page. Null when there is no further page. Treat as an opaque string; the format may change without notice.
### Example
```http
curl https://api.anthropic.com/v1/compliance/apps/sessions/local \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
#### Response
```json
{
"data": [
{
"type": "compliance_local_session",
"id": "clls_eyJ2IjoxLCJvIjoiOWEx…",
"organization_uuid": "9a1e0000-0000-0000-0000-000000000000",
"workspace_id": "wrkspc_01SvYKoWVRVHoEbwESNvzYdR",
"user": {
"id": "user_01GpKpLmNoPqRsTuVwXyZaBc",
"email_address": "[email protected]"
},
"product_surface": "cowork",
"created_at": "2026-07-09T14:02:11Z"
}
]
}
```
## Retrieve a local session
**get** `/v1/compliance/apps/sessions/local/{local_session_id}`
Retrieve one local session.
The response is the same session object the list endpoint returns,
with `user.email_address` resolved the same way. Retention is
enforced when the response is served: a session whose every
inference call has aged out returns 404.
### Path Parameters
- `local_session_id: string`
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `id: string`
Local session identifier, prefixed `clls_`. Unique within the parent organization. Treat as an opaque string; the format may change without notice.
- `created_at: string`
Timestamp of the session's first retained inference call (RFC 3339, UTC). When a session's activity spans the child organization's retention boundary, calls older than the boundary are no longer reflected, so this value is the timestamp of the earliest retained call: always strictly after the boundary, never the boundary itself.
- `organization_uuid: string`
UUID of the child organization the session belongs to
- `product_surface: string or null`
The product the session ran in: `cowork` for Cowork sessions in Claude Desktop, or `claude_code` for Claude Code sessions. New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded.
- `type: "compliance_local_session"`
- `"compliance_local_session"`
- `user: object { id, email_address }`
The authenticated user at the time of the session. Always set; `user.id` is always populated. `user.email_address` is null when the user's account has been deleted or the user is no longer a member of an organization the key may read.
- `id: string`
User identifier (tagged ID, prefixed `user_`). Always set, so attribution survives after the user's account is deleted or the user leaves the organizations the key may read.
- `email_address: string or null`
User's email address. Null when the user's account has been deleted or the user is no longer a member of an organization the key may read. The messages endpoint does not resolve email addresses; this field is always null there.
- `workspace_id: string or null`
Workspace identifier (tagged ID, prefixed `wrkspc_`). Null for sessions not attributed to a workspace.
### Example
```http
curl https://api.anthropic.com/v1/compliance/apps/sessions/local/$LOCAL_SESSION_ID \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
#### Response
```json
{
"type": "compliance_local_session",
"id": "clls_eyJ2IjoxLCJvIjoiOWEx…",
"organization_uuid": "9a1e0000-0000-0000-0000-000000000000",
"workspace_id": "wrkspc_01SvYKoWVRVHoEbwESNvzYdR",
"user": {
"id": "user_01GpKpLmNoPqRsTuVwXyZaBc",
"email_address": "[email protected]"
},
"product_surface": "cowork",
"created_at": "2026-07-09T14:02:11Z"
}
```
## Domain Types
### Local List Response
- `LocalListResponse object { id, created_at, organization_uuid, 4 more }`
A Cowork or Claude Code session that a user ran on their own computer
while signed in with their organization account.
- `id: string`
Local session identifier, prefixed `clls_`. Unique within the parent organization. Treat as an opaque string; the format may change without notice.
- `created_at: string`
Timestamp of the session's first retained inference call (RFC 3339, UTC). When a session's activity spans the child organization's retention boundary, calls older than the boundary are no longer reflected, so this value is the timestamp of the earliest retained call: always strictly after the boundary, never the boundary itself.
- `organization_uuid: string`
UUID of the child organization the session belongs to
- `product_surface: string or null`
The product the session ran in: `cowork` for Cowork sessions in Claude Desktop, or `claude_code` for Claude Code sessions. New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded.
- `type: "compliance_local_session"`
- `"compliance_local_session"`
- `user: object { id, email_address }`
The authenticated user at the time of the session. Always set; `user.id` is always populated. `user.email_address` is null when the user's account has been deleted or the user is no longer a member of an organization the key may read.
- `id: string`
User identifier (tagged ID, prefixed `user_`). Always set, so attribution survives after the user's account is deleted or the user leaves the organizations the key may read.
- `email_address: string or null`
User's email address. Null when the user's account has been deleted or the user is no longer a member of an organization the key may read. The messages endpoint does not resolve email addresses; this field is always null there.
- `workspace_id: string or null`
Workspace identifier (tagged ID, prefixed `wrkspc_`). Null for sessions not attributed to a workspace.
### Local Retrieve Response
- `LocalRetrieveResponse object { id, created_at, organization_uuid, 4 more }`
A Cowork or Claude Code session that a user ran on their own computer
while signed in with their organization account.
- `id: string`
Local session identifier, prefixed `clls_`. Unique within the parent organization. Treat as an opaque string; the format may change without notice.
- `created_at: string`
Timestamp of the session's first retained inference call (RFC 3339, UTC). When a session's activity spans the child organization's retention boundary, calls older than the boundary are no longer reflected, so this value is the timestamp of the earliest retained call: always strictly after the boundary, never the boundary itself.
- `organization_uuid: string`
UUID of the child organization the session belongs to
- `product_surface: string or null`
The product the session ran in: `cowork` for Cowork sessions in Claude Desktop, or `claude_code` for Claude Code sessions. New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded.
- `type: "compliance_local_session"`
- `"compliance_local_session"`
- `user: object { id, email_address }`
The authenticated user at the time of the session. Always set; `user.id` is always populated. `user.email_address` is null when the user's account has been deleted or the user is no longer a member of an organization the key may read.
- `id: string`
User identifier (tagged ID, prefixed `user_`). Always set, so attribution survives after the user's account is deleted or the user leaves the organizations the key may read.
- `email_address: string or null`
User's email address. Null when the user's account has been deleted or the user is no longer a member of an organization the key may read. The messages endpoint does not resolve email addresses; this field is always null there.
- `workspace_id: string or null`
Workspace identifier (tagged ID, prefixed `wrkspc_`). Null for sessions not attributed to a workspace.
# Messages
## Retrieve local session messages
**get** `/v1/compliance/apps/sessions/local/{local_session_id}/messages`
Read one local session's transcript, oldest-first by default.
Retention is enforced read-side: turns at or before the child
organization's retention boundary are never returned; a session
that straddles the boundary carries one leading
`content_unavailable` placeholder (`reason: "retention_elapsed"`)
in their place. The boundary is pinned on the walk's first page and
honored for 24 hours: a cursor older than that is rejected with an
explicit 400; restart the walk to read under the current boundary.
Cut at 300 lines. The page has the rest.
api/compliance/apps/sessions/local First recorded · 724 lines, first recorded
# Local ## List local sessions ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Retrieve a local session ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Local List Response ### Local Retrieve Response # Messages ## Retrieve local session messages ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Message List Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Local
url: https://platform.claude.com/docs/en/api/compliance/apps/sessions/local
---
# Local
## List local sessions
**get** `/v1/compliance/apps/sessions/local`
List local sessions across the organizations the key may read.
Results are ordered by `created_at` descending. Pagination is
forward-only via `next_page`; there is no reverse cursor.
### Query Parameters
- `created_at: optional object { gte, lt }`
- `gte: optional string`
Only return sessions whose first inference call is at or after this time (RFC 3339; a UTC offset is required).
- `lt: optional string`
Only return sessions whose first inference call is strictly before this time (RFC 3339; a UTC offset is required).
- `limit: optional number`
Maximum results (default: 100, max: 500)
- `page: optional string`
Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `data: array of object { id, created_at, organization_uuid, 4 more }`
Page of local sessions, ordered by `created_at` descending; ties are broken by a fixed server-side order.
- `id: string`
Local session identifier, prefixed `clls_`. Unique within the parent organization. Treat as an opaque string; the format may change without notice.
- `created_at: string`
Timestamp of the session's first retained inference call (RFC 3339, UTC). When a session's activity spans the child organization's retention boundary, calls older than the boundary are no longer reflected, so this value is the timestamp of the earliest retained call: always strictly after the boundary, never the boundary itself.
- `organization_uuid: string`
UUID of the child organization the session belongs to
- `product_surface: string or null`
The product the session ran in: `cowork` for Cowork sessions in Claude Desktop, or `claude_code` for Claude Code sessions. New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded.
- `type: "compliance_local_session"`
- `"compliance_local_session"`
- `user: object { id, email_address }`
The authenticated user at the time of the session. Always set; `user.id` is always populated. `user.email_address` is null when the user's account has been deleted or the user is no longer a member of an organization the key may read.
- `id: string`
User identifier (tagged ID, prefixed `user_`). Always set, so attribution survives after the user's account is deleted or the user leaves the organizations the key may read.
- `email_address: string or null`
User's email address. Null when the user's account has been deleted or the user is no longer a member of an organization the key may read. The messages endpoint does not resolve email addresses; this field is always null there.
- `workspace_id: string or null`
Workspace identifier (tagged ID, prefixed `wrkspc_`). Null for sessions not attributed to a workspace.
- `next_page: string or null`
Opaque pagination cursor (prefixed `page_`) for the next page. Null when there is no further page. Treat as an opaque string; the format may change without notice.
### Example
```http
curl https://api.anthropic.com/v1/compliance/apps/sessions/local \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
#### Response
```json
{
"data": [
{
"type": "compliance_local_session",
"id": "clls_eyJ2IjoxLCJvIjoiOWEx…",
"organization_uuid": "9a1e0000-0000-0000-0000-000000000000",
"workspace_id": "wrkspc_01SvYKoWVRVHoEbwESNvzYdR",
"user": {
"id": "user_01GpKpLmNoPqRsTuVwXyZaBc",
"email_address": "[email protected]"
},
"product_surface": "cowork",
"created_at": "2026-07-09T14:02:11Z"
}
]
}
```
## Retrieve a local session
**get** `/v1/compliance/apps/sessions/local/{local_session_id}`
Retrieve one local session.
The response is the same session object the list endpoint returns,
with `user.email_address` resolved the same way. Retention is
enforced when the response is served: a session whose every
inference call has aged out returns 404.
### Path Parameters
- `local_session_id: string`
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `id: string`
Local session identifier, prefixed `clls_`. Unique within the parent organization. Treat as an opaque string; the format may change without notice.
- `created_at: string`
Timestamp of the session's first retained inference call (RFC 3339, UTC). When a session's activity spans the child organization's retention boundary, calls older than the boundary are no longer reflected, so this value is the timestamp of the earliest retained call: always strictly after the boundary, never the boundary itself.
- `organization_uuid: string`
UUID of the child organization the session belongs to
- `product_surface: string or null`
The product the session ran in: `cowork` for Cowork sessions in Claude Desktop, or `claude_code` for Claude Code sessions. New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded.
- `type: "compliance_local_session"`
- `"compliance_local_session"`
- `user: object { id, email_address }`
The authenticated user at the time of the session. Always set; `user.id` is always populated. `user.email_address` is null when the user's account has been deleted or the user is no longer a member of an organization the key may read.
- `id: string`
User identifier (tagged ID, prefixed `user_`). Always set, so attribution survives after the user's account is deleted or the user leaves the organizations the key may read.
- `email_address: string or null`
User's email address. Null when the user's account has been deleted or the user is no longer a member of an organization the key may read. The messages endpoint does not resolve email addresses; this field is always null there.
- `workspace_id: string or null`
Workspace identifier (tagged ID, prefixed `wrkspc_`). Null for sessions not attributed to a workspace.
### Example
```http
curl https://api.anthropic.com/v1/compliance/apps/sessions/local/$LOCAL_SESSION_ID \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
#### Response
```json
{
"type": "compliance_local_session",
"id": "clls_eyJ2IjoxLCJvIjoiOWEx…",
"organization_uuid": "9a1e0000-0000-0000-0000-000000000000",
"workspace_id": "wrkspc_01SvYKoWVRVHoEbwESNvzYdR",
"user": {
"id": "user_01GpKpLmNoPqRsTuVwXyZaBc",
"email_address": "[email protected]"
},
"product_surface": "cowork",
"created_at": "2026-07-09T14:02:11Z"
}
```
## Domain Types
### Local List Response
- `LocalListResponse object { id, created_at, organization_uuid, 4 more }`
A Cowork or Claude Code session that a user ran on their own computer
while signed in with their organization account.
- `id: string`
Local session identifier, prefixed `clls_`. Unique within the parent organization. Treat as an opaque string; the format may change without notice.
- `created_at: string`
Timestamp of the session's first retained inference call (RFC 3339, UTC). When a session's activity spans the child organization's retention boundary, calls older than the boundary are no longer reflected, so this value is the timestamp of the earliest retained call: always strictly after the boundary, never the boundary itself.
- `organization_uuid: string`
UUID of the child organization the session belongs to
- `product_surface: string or null`
The product the session ran in: `cowork` for Cowork sessions in Claude Desktop, or `claude_code` for Claude Code sessions. New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded.
- `type: "compliance_local_session"`
- `"compliance_local_session"`
- `user: object { id, email_address }`
The authenticated user at the time of the session. Always set; `user.id` is always populated. `user.email_address` is null when the user's account has been deleted or the user is no longer a member of an organization the key may read.
- `id: string`
User identifier (tagged ID, prefixed `user_`). Always set, so attribution survives after the user's account is deleted or the user leaves the organizations the key may read.
- `email_address: string or null`
User's email address. Null when the user's account has been deleted or the user is no longer a member of an organization the key may read. The messages endpoint does not resolve email addresses; this field is always null there.
- `workspace_id: string or null`
Workspace identifier (tagged ID, prefixed `wrkspc_`). Null for sessions not attributed to a workspace.
### Local Retrieve Response
- `LocalRetrieveResponse object { id, created_at, organization_uuid, 4 more }`
A Cowork or Claude Code session that a user ran on their own computer
while signed in with their organization account.
- `id: string`
Local session identifier, prefixed `clls_`. Unique within the parent organization. Treat as an opaque string; the format may change without notice.
- `created_at: string`
Timestamp of the session's first retained inference call (RFC 3339, UTC). When a session's activity spans the child organization's retention boundary, calls older than the boundary are no longer reflected, so this value is the timestamp of the earliest retained call: always strictly after the boundary, never the boundary itself.
- `organization_uuid: string`
UUID of the child organization the session belongs to
- `product_surface: string or null`
The product the session ran in: `cowork` for Cowork sessions in Claude Desktop, or `claude_code` for Claude Code sessions. New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded.
- `type: "compliance_local_session"`
- `"compliance_local_session"`
- `user: object { id, email_address }`
The authenticated user at the time of the session. Always set; `user.id` is always populated. `user.email_address` is null when the user's account has been deleted or the user is no longer a member of an organization the key may read.
- `id: string`
User identifier (tagged ID, prefixed `user_`). Always set, so attribution survives after the user's account is deleted or the user leaves the organizations the key may read.
- `email_address: string or null`
User's email address. Null when the user's account has been deleted or the user is no longer a member of an organization the key may read. The messages endpoint does not resolve email addresses; this field is always null there.
- `workspace_id: string or null`
Workspace identifier (tagged ID, prefixed `wrkspc_`). Null for sessions not attributed to a workspace.
# Messages
## Retrieve local session messages
**get** `/v1/compliance/apps/sessions/local/{local_session_id}/messages`
Read one local session's transcript, oldest-first by default.
Retention is enforced read-side: turns at or before the child
organization's retention boundary are never returned; a session
that straddles the boundary carries one leading
`content_unavailable` placeholder (`reason: "retention_elapsed"`)
in their place. The boundary is pinned on the walk's first page and
honored for 24 hours: a cursor older than that is rejected with an
explicit 400; restart the walk to read under the current boundary.
### Path Parameters
Cut at 300 lines. The page has the rest.