One read of Claude Developer Platformapi-20261112T203713Z
139 pages moved out of 916 read.
Pages moved
139
significant first
Pages read
916
in this capture
Captured
20:37 UTC
Corpus hash
59cd06ab8c5c
corpus-hash
What this read moved
51-75 of 139, page 3 of 6This capture is too large to show at once. Changes 51-75 of 139 are below, significant first; the rest are on the following screens.
api/compliance/apps/chats/list Changed · +6 / -6 lines
from line 119
119119
120120## Headers
121121
122- `"anthropic-version": optional string`
122- `"anthropic-version": string`
123123
124 The version of the Claude API you want to use.
124 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
125125
126 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
126 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
127127
128128- `"x-api-key": optional string`
129129
from line 209
209209
210210```bash
211211curl https://api.anthropic.com/v1/compliance/apps/chats \
212 -H 'anthropic-version: 2023-06-01' \
212 -H 'anthropic-version: 2026-10-21' \
213213 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
214214```
215215
api/compliance/apps/chats/messages Changed · +6 / -6 lines
from line 109
109109
110110### Headers
111111
112- `"anthropic-version": optional string`
112- `"anthropic-version": string`
113113
114 The version of the Claude API you want to use.
114 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
115115
116 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
116 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
117117
118118- `"x-api-key": optional string`
119119
from line 407
407407
408408```bash
409409curl https://api.anthropic.com/v1/compliance/apps/chats/$CLAUDE_CHAT_ID/messages \
410 -H 'anthropic-version: 2023-06-01' \
410 -H 'anthropic-version: 2026-10-21' \
411411 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
412412```
413413
api/compliance/apps/chats/messages/list Changed · +6 / -6 lines
from line 107
107107
108108## Headers
109109
110- `"anthropic-version": optional string`
110- `"anthropic-version": string`
111111
112 The version of the Claude API you want to use.
112 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
113113
114 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
114 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
115115
116116- `"x-api-key": optional string`
117117
from line 405
405405
406406```bash
407407curl https://api.anthropic.com/v1/compliance/apps/chats/$CLAUDE_CHAT_ID/messages \
408 -H 'anthropic-version: 2023-06-01' \
408 -H 'anthropic-version: 2026-10-21' \
409409 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
410410```
411411
api/compliance/apps/code Changed · +42 / -38 lines
from line 76
7676
7777#### Headers
7878
79- `"anthropic-version": optional string`
79- `"anthropic-version": string`
8080
81 The version of the Claude API you want to use.
81 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
8282
83 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
83 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
8484
8585- `"x-api-key": optional string`
8686
from line 94
9494
9595 Artifact identifier (tagged ID)
9696
97 - `artifact_type: "claude_dashboards" or "claude_design" or "claude_design_systems" or 5 more`
97 - `artifact_type: "claude_dashboards" or "claude_design" or "claude_design_systems" or 6 more`
9898
99 Which kind of Artifact this is: `code` for a site published from Claude Code, or the built-in Artifact type it was made from — `claude_docs` (Claude Docs), `claude_slides` (Slides), `claude_design` (Design), `claude_design_systems` (a design system), `claude_motion` (Motion) or `claude_dashboards` (Dashboards). `other` is an Artifact made from a built-in type this list does not name yet.
99 Which kind of Artifact this is: `code` for a site published from Claude Code, or the built-in Artifact type it was made from — `claude_docs` (Claude Docs), `claude_slides` (Slides), `claude_design` (Design), `claude_design_systems` (a design system), `claude_motion` (Motion), `claude_dashboards` (Dashboards) or `claude_sheets` (Claude Sheets). `other` is an Artifact made from a built-in type this list does not name yet.
100100
101101 - `"claude_dashboards"`
102102
from line 108
108108
109109 - `"claude_motion"`
110110
111 - `"claude_sheets"`
112
111113 - `"claude_slides"`
112114
113115 - `"code"`
from line 126
124126
125127 - `published_version_id: string or null`
126128
127 Identifier of the version a non-owner viewer would render when `read_mode` permits them — the version the owner has pinned for non-owner readers if one is pinned, otherwise the owner's latest. When `read_mode` is `owner` no non-owner renders any version; the field still reports which version would be served were read_mode widened. Null for a Claude Doc; see `versions`.
129 Identifier of the version a non-owner viewer would render when `read_mode` permits them — the version the owner has pinned for non-owner readers if one is pinned, otherwise the owner's latest. When `read_mode` is `owner` no non-owner renders any version; the field still reports which version would be served were read_mode widened. Null for a Claude Doc or a Claude Sheet; see `versions`.
128130
129131 - `read_mode: "org" or "owner" or "public" or "users"`
130132
from line 160
158160
159161 - `versions: array of object`
160162
161 Up to roughly 20 most-recently-published versions of this Artifact (older versions are not retained). Metadata only — use `GET /v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}` to download a version's content. Empty for a Claude Doc, because a Doc's versions hold only the web page that displays it, not its text. Download a Doc's text with `GET /v1/compliance/apps/code/artifacts/{artifact_id}/content?multi_file_format=zip`.
163 Up to roughly 20 most-recently-published versions of this Artifact (older versions are not retained). Metadata only — use `GET /v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}` to download a version's content. Empty for a Claude Doc or a Claude Sheet, because their versions hold only the web page that displays them, not the Doc's text or the Sheet's data. Download a Doc's text or a Sheet's data with `GET /v1/compliance/apps/code/artifacts/{artifact_id}/content?multi_file_format=zip`.
162164
163165 - `id: string`
164166
from line 188
186188
187189```bash
188190curl https://api.anthropic.com/v1/compliance/apps/code/artifacts \
189 -H 'anthropic-version: 2023-06-01' \
191 -H 'anthropic-version: 2026-10-21' \
190192 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
191193```
192194
from line 227
225227
226228**GET** `/v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}`
227229
228Streams the content of one version of an Artifact as the response body, in chunks with no `Content-Length`. With `multi_file_format=zip`, a version with more than one file, other than a Claude Doc's (an Artifact whose `artifact_type` is `claude_docs`), comes back as a ZIP archive of its files.
230Streams the content of one version of an Artifact as the response body, in chunks with no `Content-Length`. With `multi_file_format=zip`, a version with more than one file, other than a Claude Doc's or a Claude Sheet's (an Artifact whose `artifact_type` is `claude_docs` or `claude_sheets`), comes back as a ZIP archive of its files.
229231
230232Headers: `Content-Type` (`application/zip` for a ZIP archive, otherwise the stored MIME type), `Content-Disposition: attachment; filename*=utf-8''<name>` (RFC 5987), `Cache-Control: no-store, private` and, when available, `Content-MD5` (base64). `<name>` is `{artifact_id}-{version_id}.zip` for a ZIP archive, otherwise `{artifact_id}-{version_id}.txt`, whatever the content is. `Content-MD5` is only on a single file stored uncompressed, so it is never on a ZIP archive. Check the body against it when present.
231233
from line 235
233235
234236- `404`: the Artifact doesn't exist or the API key cannot read it, or the version is no longer kept. Older versions are dropped as new ones are published, so list the Artifact's versions again. You also get this when the organization's customer-managed encryption key can't be used. Retry once the key can be used again.
235237- `503`: the content can't be served right now, for example because its upload is still in progress or was abandoned. Retry with backoff.
236- `422` with `error.details.error_code` `multi_file_unavailable`: the version has more than one file. Add `multi_file_format=zip`. A Claude Doc's version with more than one file gets this error either way, because it holds only the web page that displays the Doc. Download the Doc's text with `GET /v1/compliance/apps/code/artifacts/{artifact_id}/content?multi_file_format=zip`.
238- `422` with `error.details.error_code` `multi_file_unavailable`: the version has more than one file. Add `multi_file_format=zip`. A Claude Doc's or a Claude Sheet's version with more than one file gets this error either way, because it holds only the web page that displays the Doc or the Sheet. Download the Doc's text or the Sheet's data with `GET /v1/compliance/apps/code/artifacts/{artifact_id}/content?multi_file_format=zip`.
237239- `422` with `file_set_unavailable`: the request sets `multi_file_format=zip`, the version has more than one file, and one of them has a path the API cannot export. Do not retry.
238240
239241An error after the download has started stops the body early, with the `200` status already sent. For example, this happens to content stored compressed when it is over 16 MiB once decompressed. For a single file with no `Content-MD5`, the only sign is a transfer that aborts before its last chunk, so treat a download that aborts this way as failed.
from line 267
265267
266268- `multi_file_format: optional string`
267269
268 Set to `zip`, its only value, to receive a version that has more than one file as a ZIP archive of its files with an index, `files.json`. A version with one file is returned as that file. A Claude Doc's version never comes back as a ZIP.
270 Set to `zip`, its only value, to receive a version that has more than one file as a ZIP archive of its files with an index, `files.json`. A version with one file is returned as that file. A Claude Doc's or a Claude Sheet's version never comes back as a ZIP.
269271
270272#### Headers
271273
272- `"anthropic-version": optional string`
274- `"anthropic-version": string`
273275
274 The version of the Claude API you want to use.
276 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
275277
276 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
278 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
277279
278280- `"x-api-key": optional string`
279281
from line 283
281283
282284```bash
283285curl https://api.anthropic.com/v1/compliance/apps/code/artifacts/$ARTIFACT_ID/versions/$VERSION_ID \
284 -H 'anthropic-version: 2023-06-01' \
286 -H 'anthropic-version: 2026-10-21' \
285287 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
286288```
287289
from line 295
293295
294296For a Claude Doc (an Artifact whose `artifact_type` is `claude_docs`), the request must set `multi_file_format=zip`, and the content is the Doc's text as a ZIP archive of Word files. That ZIP has no `files.json`. It holds one Word file per text tab, in tab order, named `NN-<tab id>.docx`, where `NN` counts from `01`. A Doc with one text tab gets one file, `01-document.docx`.
295297
298For a Claude Sheet (an Artifact whose `artifact_type` is `claude_sheets`), the request must set `multi_file_format=zip` too, and the content is the Sheet's data as a ZIP archive that holds one .xlsx file, named `01-<id>.xlsx`, where `<id>` is an opaque identifier. The file has all of the Sheet's tabs and, when the Sheet has dropdowns, one more hidden tab that lists their options. It leaves out charts, conditional formatting and comments, among other things. A formula that an .xlsx file cannot hold is written as its result. If the Sheet's formulas cannot be calculated in time, every formula comes with `#VALUE!` in place of its result. That ZIP has no `files.json` either.
299
296300For any other Artifact, the content is the latest version. With `multi_file_format=zip`, when the latest version has more than one file, it comes back as a ZIP archive of its files.
297301
298Headers: `Content-Type` (`application/zip` for a ZIP archive, otherwise the stored MIME type), `Content-Disposition: attachment; filename*=utf-8''<name>` (RFC 5987), `Cache-Control: no-store, private` and, when available, `Content-MD5` (base64). `<name>` is `{artifact_id}.zip` for a ZIP archive, otherwise `{artifact_id}.txt`, whatever the content is. `Content-MD5` is always on a Claude Doc's ZIP, only on a single file stored uncompressed, and never on a ZIP archive of a version's files. Check the body against it when present.
302Headers: `Content-Type` (`application/zip` for a ZIP archive, otherwise the stored MIME type), `Content-Disposition: attachment; filename*=utf-8''<name>` (RFC 5987), `Cache-Control: no-store, private` and, when available, `Content-MD5` (base64). `<name>` is `{artifact_id}.zip` for a ZIP archive, otherwise `{artifact_id}.txt`, whatever the content is. `Content-MD5` is always on a Claude Doc's or a Claude Sheet's ZIP, only on a single file stored uncompressed, and never on a ZIP archive of a version's files. Check the body against it when present.
299303
300304Errors specific to this download:
301305
from line 306
302306- `404`: the Artifact doesn't exist, or the API key cannot read it.
303307- `400` with `error.details.error_code` `cmek_key_disabled`: the organization's customer-managed encryption key can't be used, for example because it is disabled or revoked. Retry once the key can be used again.
304308- `503`: the content can't be produced right now. Wait the number of seconds in the `Retry-After` header, or retry with backoff when it is absent.
305- `422` with `multi_file_unavailable`: the request does not set `multi_file_format=zip`, and the Artifact is a Claude Doc or its latest version has more than one file. Add the parameter.
306- `422` with `file_set_unavailable`: the request sets `multi_file_format=zip`, the Artifact is not a Claude Doc, and one of the latest version's files has a path the API cannot export. Do not retry.
307- `422` with `document_unavailable`: Claude Docs has no document it can export for the Doc, for example because it has no text tab or is in the trash. Retrying will not help unless that changes.
308- `422` with `document_too_large`: the Doc's export is over 16 MiB. Do not retry.
309- `422` with `multi_file_unavailable`: the request does not set `multi_file_format=zip`, and the Artifact is a Claude Doc or a Claude Sheet, or its latest version has more than one file. Add the parameter.
310- `422` with `file_set_unavailable`: the request sets `multi_file_format=zip`, the Artifact is neither a Claude Doc nor a Claude Sheet, and one of the latest version's files has a path the API cannot export. Do not retry.
311- `422` with `document_unavailable`: Claude Docs has no document it can export for the Doc, for example because it has no text tab or is in the trash. For a Claude Sheet, nothing can be returned as an .xlsx file, for example because the Sheet is in the trash. Retrying will not help unless that changes.
312- `422` with `document_too_large`: the Doc's or the Sheet's export is over 16 MiB. Do not retry.
309313- `422` with `cmek_org_unsupported`: the organization uses customer-managed encryption keys and the export can't be served for it right now. Try again later, and contact Anthropic support if this continues.
310314
311315An error after the download has started stops the body early, with the `200` status already sent. For example, this happens to content stored compressed when it is over 16 MiB once decompressed. For a single file with no `Content-MD5`, the only sign is a transfer that aborts before its last chunk, so treat a download that aborts this way as failed.
from line 337
333337
334338- `multi_file_format: optional string`
335339
336 Set to `zip`, its only value. A Claude Doc downloads only this way, as a ZIP archive of Word files, one per text tab. For any other Artifact, when the latest version has more than one file, it comes back as a ZIP archive of its files with an index, `files.json`.
340 Set to `zip`, its only value. A Claude Doc downloads only this way, as a ZIP archive of Word files, one per text tab. So does a Claude Sheet, as a ZIP archive that holds one .xlsx file. For any other Artifact, when the latest version has more than one file, it comes back as a ZIP archive of its files with an index, `files.json`.
337341
338342#### Headers
339343
340- `"anthropic-version": optional string`
344- `"anthropic-version": string`
341345
342 The version of the Claude API you want to use.
346 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
343347
344 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
348 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
345349
346350- `"x-api-key": optional string`
347351
from line 353
349353
350354```bash
351355curl https://api.anthropic.com/v1/compliance/apps/code/artifacts/$ARTIFACT_ID/content \
352 -H 'anthropic-version: 2023-06-01' \
356 -H 'anthropic-version: 2026-10-21' \
353357 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
354358```
355359
from line 378
374378
375379#### Headers
376380
377- `"anthropic-version": optional string`
381- `"anthropic-version": string`
378382
379 The version of the Claude API you want to use.
383 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
380384
381 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
385 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
382386
383387- `"x-api-key": optional string`
384388
from line 403
399403```bash
400404curl https://api.anthropic.com/v1/compliance/apps/code/artifacts/$ARTIFACT_ID \
401405 -X DELETE \
402 -H 'anthropic-version: 2023-06-01' \
406 -H 'anthropic-version: 2026-10-21' \
403407 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
404408```
405409
api/compliance/apps/code/artifacts Changed · +49 / -43 lines
from line 74
7474
7575### Headers
7676
77- `"anthropic-version": optional string`
77- `"anthropic-version": string`
7878
79 The version of the Claude API you want to use.
79 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
8080
81 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
81 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
8282
8383- `"x-api-key": optional string`
8484
from line 92
9292
9393 Artifact identifier (tagged ID)
9494
95 - `artifact_type: "claude_dashboards" or "claude_design" or "claude_design_systems" or 5 more`
95 - `artifact_type: "claude_dashboards" or "claude_design" or "claude_design_systems" or 6 more`
9696
97 Which kind of Artifact this is: `code` for a site published from Claude Code, or the built-in Artifact type it was made from — `claude_docs` (Claude Docs), `claude_slides` (Slides), `claude_design` (Design), `claude_design_systems` (a design system), `claude_motion` (Motion) or `claude_dashboards` (Dashboards). `other` is an Artifact made from a built-in type this list does not name yet.
97 Which kind of Artifact this is: `code` for a site published from Claude Code, or the built-in Artifact type it was made from — `claude_docs` (Claude Docs), `claude_slides` (Slides), `claude_design` (Design), `claude_design_systems` (a design system), `claude_motion` (Motion), `claude_dashboards` (Dashboards) or `claude_sheets` (Claude Sheets). `other` is an Artifact made from a built-in type this list does not name yet.
9898
9999 - `"claude_dashboards"`
100100
from line 106
106106
107107 - `"claude_motion"`
108108
109 - `"claude_sheets"`
110
109111 - `"claude_slides"`
110112
111113 - `"code"`
from line 124
122124
123125 - `published_version_id: string or null`
124126
125 Identifier of the version a non-owner viewer would render when `read_mode` permits them — the version the owner has pinned for non-owner readers if one is pinned, otherwise the owner's latest. When `read_mode` is `owner` no non-owner renders any version; the field still reports which version would be served were read_mode widened. Null for a Claude Doc; see `versions`.
127 Identifier of the version a non-owner viewer would render when `read_mode` permits them — the version the owner has pinned for non-owner readers if one is pinned, otherwise the owner's latest. When `read_mode` is `owner` no non-owner renders any version; the field still reports which version would be served were read_mode widened. Null for a Claude Doc or a Claude Sheet; see `versions`.
126128
127129 - `read_mode: "org" or "owner" or "public" or "users"`
128130
from line 158
156158
157159 - `versions: array of object`
158160
159 Up to roughly 20 most-recently-published versions of this Artifact (older versions are not retained). Metadata only — use `GET /v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}` to download a version's content. Empty for a Claude Doc, because a Doc's versions hold only the web page that displays it, not its text. Download a Doc's text with `GET /v1/compliance/apps/code/artifacts/{artifact_id}/content?multi_file_format=zip`.
161 Up to roughly 20 most-recently-published versions of this Artifact (older versions are not retained). Metadata only — use `GET /v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}` to download a version's content. Empty for a Claude Doc or a Claude Sheet, because their versions hold only the web page that displays them, not the Doc's text or the Sheet's data. Download a Doc's text or a Sheet's data with `GET /v1/compliance/apps/code/artifacts/{artifact_id}/content?multi_file_format=zip`.
160162
161163 - `id: string`
162164
from line 186
184186
185187```bash
186188curl https://api.anthropic.com/v1/compliance/apps/code/artifacts \
187 -H 'anthropic-version: 2023-06-01' \
189 -H 'anthropic-version: 2026-10-21' \
188190 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
189191```
190192
from line 225
223225
224226**GET** `/v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}`
225227
226Streams the content of one version of an Artifact as the response body, in chunks with no `Content-Length`. With `multi_file_format=zip`, a version with more than one file, other than a Claude Doc's (an Artifact whose `artifact_type` is `claude_docs`), comes back as a ZIP archive of its files.
228Streams the content of one version of an Artifact as the response body, in chunks with no `Content-Length`. With `multi_file_format=zip`, a version with more than one file, other than a Claude Doc's or a Claude Sheet's (an Artifact whose `artifact_type` is `claude_docs` or `claude_sheets`), comes back as a ZIP archive of its files.
227229
228230Headers: `Content-Type` (`application/zip` for a ZIP archive, otherwise the stored MIME type), `Content-Disposition: attachment; filename*=utf-8''<name>` (RFC 5987), `Cache-Control: no-store, private` and, when available, `Content-MD5` (base64). `<name>` is `{artifact_id}-{version_id}.zip` for a ZIP archive, otherwise `{artifact_id}-{version_id}.txt`, whatever the content is. `Content-MD5` is only on a single file stored uncompressed, so it is never on a ZIP archive. Check the body against it when present.
229231
from line 233
231233
232234- `404`: the Artifact doesn't exist or the API key cannot read it, or the version is no longer kept. Older versions are dropped as new ones are published, so list the Artifact's versions again. You also get this when the organization's customer-managed encryption key can't be used. Retry once the key can be used again.
233235- `503`: the content can't be served right now, for example because its upload is still in progress or was abandoned. Retry with backoff.
234- `422` with `error.details.error_code` `multi_file_unavailable`: the version has more than one file. Add `multi_file_format=zip`. A Claude Doc's version with more than one file gets this error either way, because it holds only the web page that displays the Doc. Download the Doc's text with `GET /v1/compliance/apps/code/artifacts/{artifact_id}/content?multi_file_format=zip`.
236- `422` with `error.details.error_code` `multi_file_unavailable`: the version has more than one file. Add `multi_file_format=zip`. A Claude Doc's or a Claude Sheet's version with more than one file gets this error either way, because it holds only the web page that displays the Doc or the Sheet. Download the Doc's text or the Sheet's data with `GET /v1/compliance/apps/code/artifacts/{artifact_id}/content?multi_file_format=zip`.
235237- `422` with `file_set_unavailable`: the request sets `multi_file_format=zip`, the version has more than one file, and one of them has a path the API cannot export. Do not retry.
236238
237239An error after the download has started stops the body early, with the `200` status already sent. For example, this happens to content stored compressed when it is over 16 MiB once decompressed. For a single file with no `Content-MD5`, the only sign is a transfer that aborts before its last chunk, so treat a download that aborts this way as failed.
from line 265
263265
264266- `multi_file_format: optional string`
265267
266 Set to `zip`, its only value, to receive a version that has more than one file as a ZIP archive of its files with an index, `files.json`. A version with one file is returned as that file. A Claude Doc's version never comes back as a ZIP.
268 Set to `zip`, its only value, to receive a version that has more than one file as a ZIP archive of its files with an index, `files.json`. A version with one file is returned as that file. A Claude Doc's or a Claude Sheet's version never comes back as a ZIP.
267269
268270### Headers
269271
270- `"anthropic-version": optional string`
272- `"anthropic-version": string`
271273
272 The version of the Claude API you want to use.
274 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
273275
274 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
276 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
275277
276278- `"x-api-key": optional string`
277279
from line 281
279281
280282```bash
281283curl https://api.anthropic.com/v1/compliance/apps/code/artifacts/$ARTIFACT_ID/versions/$VERSION_ID \
282 -H 'anthropic-version: 2023-06-01' \
284 -H 'anthropic-version: 2026-10-21' \
283285 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
284286```
285287
from line 293
291293
292294For a Claude Doc (an Artifact whose `artifact_type` is `claude_docs`), the request must set `multi_file_format=zip`, and the content is the Doc's text as a ZIP archive of Word files. That ZIP has no `files.json`. It holds one Word file per text tab, in tab order, named `NN-<tab id>.docx`, where `NN` counts from `01`. A Doc with one text tab gets one file, `01-document.docx`.
293295
296For a Claude Sheet (an Artifact whose `artifact_type` is `claude_sheets`), the request must set `multi_file_format=zip` too, and the content is the Sheet's data as a ZIP archive that holds one .xlsx file, named `01-<id>.xlsx`, where `<id>` is an opaque identifier. The file has all of the Sheet's tabs and, when the Sheet has dropdowns, one more hidden tab that lists their options. It leaves out charts, conditional formatting and comments, among other things. A formula that an .xlsx file cannot hold is written as its result. If the Sheet's formulas cannot be calculated in time, every formula comes with `#VALUE!` in place of its result. That ZIP has no `files.json` either.
297
294298For any other Artifact, the content is the latest version. With `multi_file_format=zip`, when the latest version has more than one file, it comes back as a ZIP archive of its files.
295299
296Headers: `Content-Type` (`application/zip` for a ZIP archive, otherwise the stored MIME type), `Content-Disposition: attachment; filename*=utf-8''<name>` (RFC 5987), `Cache-Control: no-store, private` and, when available, `Content-MD5` (base64). `<name>` is `{artifact_id}.zip` for a ZIP archive, otherwise `{artifact_id}.txt`, whatever the content is. `Content-MD5` is always on a Claude Doc's ZIP, only on a single file stored uncompressed, and never on a ZIP archive of a version's files. Check the body against it when present.
300Headers: `Content-Type` (`application/zip` for a ZIP archive, otherwise the stored MIME type), `Content-Disposition: attachment; filename*=utf-8''<name>` (RFC 5987), `Cache-Control: no-store, private` and, when available, `Content-MD5` (base64). `<name>` is `{artifact_id}.zip` for a ZIP archive, otherwise `{artifact_id}.txt`, whatever the content is. `Content-MD5` is always on a Claude Doc's or a Claude Sheet's ZIP, only on a single file stored uncompressed, and never on a ZIP archive of a version's files. Check the body against it when present.
297301
298302Errors specific to this download:
299303
from line 304
300304- `404`: the Artifact doesn't exist, or the API key cannot read it.
301305- `400` with `error.details.error_code` `cmek_key_disabled`: the organization's customer-managed encryption key can't be used, for example because it is disabled or revoked. Retry once the key can be used again.
302306- `503`: the content can't be produced right now. Wait the number of seconds in the `Retry-After` header, or retry with backoff when it is absent.
303- `422` with `multi_file_unavailable`: the request does not set `multi_file_format=zip`, and the Artifact is a Claude Doc or its latest version has more than one file. Add the parameter.
304- `422` with `file_set_unavailable`: the request sets `multi_file_format=zip`, the Artifact is not a Claude Doc, and one of the latest version's files has a path the API cannot export. Do not retry.
305- `422` with `document_unavailable`: Claude Docs has no document it can export for the Doc, for example because it has no text tab or is in the trash. Retrying will not help unless that changes.
306- `422` with `document_too_large`: the Doc's export is over 16 MiB. Do not retry.
307- `422` with `multi_file_unavailable`: the request does not set `multi_file_format=zip`, and the Artifact is a Claude Doc or a Claude Sheet, or its latest version has more than one file. Add the parameter.
308- `422` with `file_set_unavailable`: the request sets `multi_file_format=zip`, the Artifact is neither a Claude Doc nor a Claude Sheet, and one of the latest version's files has a path the API cannot export. Do not retry.
309- `422` with `document_unavailable`: Claude Docs has no document it can export for the Doc, for example because it has no text tab or is in the trash. For a Claude Sheet, nothing can be returned as an .xlsx file, for example because the Sheet is in the trash. Retrying will not help unless that changes.
310- `422` with `document_too_large`: the Doc's or the Sheet's export is over 16 MiB. Do not retry.
307311- `422` with `cmek_org_unsupported`: the organization uses customer-managed encryption keys and the export can't be served for it right now. Try again later, and contact Anthropic support if this continues.
308312
309313An error after the download has started stops the body early, with the `200` status already sent. For example, this happens to content stored compressed when it is over 16 MiB once decompressed. For a single file with no `Content-MD5`, the only sign is a transfer that aborts before its last chunk, so treat a download that aborts this way as failed.
from line 335
331335
332336- `multi_file_format: optional string`
333337
334 Set to `zip`, its only value. A Claude Doc downloads only this way, as a ZIP archive of Word files, one per text tab. For any other Artifact, when the latest version has more than one file, it comes back as a ZIP archive of its files with an index, `files.json`.
338 Set to `zip`, its only value. A Claude Doc downloads only this way, as a ZIP archive of Word files, one per text tab. So does a Claude Sheet, as a ZIP archive that holds one .xlsx file. For any other Artifact, when the latest version has more than one file, it comes back as a ZIP archive of its files with an index, `files.json`.
335339
336340### Headers
337341
338- `"anthropic-version": optional string`
342- `"anthropic-version": string`
339343
340 The version of the Claude API you want to use.
344 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
341345
342 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
346 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
343347
344348- `"x-api-key": optional string`
345349
from line 351
347351
348352```bash
349353curl https://api.anthropic.com/v1/compliance/apps/code/artifacts/$ARTIFACT_ID/content \
350 -H 'anthropic-version: 2023-06-01' \
354 -H 'anthropic-version: 2026-10-21' \
351355 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
352356```
353357
from line 376
372376
373377### Headers
374378
375- `"anthropic-version": optional string`
379- `"anthropic-version": string`
376380
377 The version of the Claude API you want to use.
381 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
378382
379 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
383 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
380384
381385- `"x-api-key": optional string`
382386
from line 401
397401```bash
398402curl https://api.anthropic.com/v1/compliance/apps/code/artifacts/$ARTIFACT_ID \
399403 -X DELETE \
400 -H 'anthropic-version: 2023-06-01' \
404 -H 'anthropic-version: 2026-10-21' \
401405 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
402406```
403407
from line 428
424428
425429 Artifact identifier (tagged ID)
426430
427 - `artifact_type: "claude_dashboards" or "claude_design" or "claude_design_systems" or 5 more`
431 - `artifact_type: "claude_dashboards" or "claude_design" or "claude_design_systems" or 6 more`
428432
429 Which kind of Artifact this is: `code` for a site published from Claude Code, or the built-in Artifact type it was made from — `claude_docs` (Claude Docs), `claude_slides` (Slides), `claude_design` (Design), `claude_design_systems` (a design system), `claude_motion` (Motion) or `claude_dashboards` (Dashboards). `other` is an Artifact made from a built-in type this list does not name yet.
433 Which kind of Artifact this is: `code` for a site published from Claude Code, or the built-in Artifact type it was made from — `claude_docs` (Claude Docs), `claude_slides` (Slides), `claude_design` (Design), `claude_design_systems` (a design system), `claude_motion` (Motion), `claude_dashboards` (Dashboards) or `claude_sheets` (Claude Sheets). `other` is an Artifact made from a built-in type this list does not name yet.
430434
431435 - `"claude_dashboards"`
432436
from line 442
438442
439443 - `"claude_motion"`
440444
445 - `"claude_sheets"`
446
441447 - `"claude_slides"`
442448
443449 - `"code"`
from line 460
454460
455461 - `published_version_id: string or null`
456462
457 Identifier of the version a non-owner viewer would render when `read_mode` permits them — the version the owner has pinned for non-owner readers if one is pinned, otherwise the owner's latest. When `read_mode` is `owner` no non-owner renders any version; the field still reports which version would be served were read_mode widened. Null for a Claude Doc; see `versions`.
463 Identifier of the version a non-owner viewer would render when `read_mode` permits them — the version the owner has pinned for non-owner readers if one is pinned, otherwise the owner's latest. When `read_mode` is `owner` no non-owner renders any version; the field still reports which version would be served were read_mode widened. Null for a Claude Doc or a Claude Sheet; see `versions`.
458464
459465 - `read_mode: "org" or "owner" or "public" or "users"`
460466
from line 494
488494
489495 - `versions: array of object`
490496
491 Up to roughly 20 most-recently-published versions of this Artifact (older versions are not retained). Metadata only — use `GET /v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}` to download a version's content. Empty for a Claude Doc, because a Doc's versions hold only the web page that displays it, not its text. Download a Doc's text with `GET /v1/compliance/apps/code/artifacts/{artifact_id}/content?multi_file_format=zip`.
497 Up to roughly 20 most-recently-published versions of this Artifact (older versions are not retained). Metadata only — use `GET /v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}` to download a version's content. Empty for a Claude Doc or a Claude Sheet, because their versions hold only the web page that displays them, not the Doc's text or the Sheet's data. Download a Doc's text or a Sheet's data with `GET /v1/compliance/apps/code/artifacts/{artifact_id}/content?multi_file_format=zip`.
492498
493499 - `id: string`
494500
api/compliance/apps/code/artifacts/delete Changed · +4 / -4 lines
from line 24
2424
2525## Headers
2626
27- `"anthropic-version": optional string`
27- `"anthropic-version": string`
2828
29 The version of the Claude API you want to use.
29 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
3030
31 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
31 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
3232
3333- `"x-api-key": optional string`
3434
from line 49
4949```bash
5050curl https://api.anthropic.com/v1/compliance/apps/code/artifacts/$ARTIFACT_ID \
5151 -X DELETE \
52 -H 'anthropic-version: 2023-06-01' \
52 -H 'anthropic-version: 2026-10-21' \
5353 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
5454```
5555
api/compliance/apps/code/artifacts/download Changed · +12 / -10 lines
from line 11
1111
1212For a Claude Doc (an Artifact whose `artifact_type` is `claude_docs`), the request must set `multi_file_format=zip`, and the content is the Doc's text as a ZIP archive of Word files. That ZIP has no `files.json`. It holds one Word file per text tab, in tab order, named `NN-<tab id>.docx`, where `NN` counts from `01`. A Doc with one text tab gets one file, `01-document.docx`.
1313
14For a Claude Sheet (an Artifact whose `artifact_type` is `claude_sheets`), the request must set `multi_file_format=zip` too, and the content is the Sheet's data as a ZIP archive that holds one .xlsx file, named `01-<id>.xlsx`, where `<id>` is an opaque identifier. The file has all of the Sheet's tabs and, when the Sheet has dropdowns, one more hidden tab that lists their options. It leaves out charts, conditional formatting and comments, among other things. A formula that an .xlsx file cannot hold is written as its result. If the Sheet's formulas cannot be calculated in time, every formula comes with `#VALUE!` in place of its result. That ZIP has no `files.json` either.
15
1416For any other Artifact, the content is the latest version. With `multi_file_format=zip`, when the latest version has more than one file, it comes back as a ZIP archive of its files.
1517
16Headers: `Content-Type` (`application/zip` for a ZIP archive, otherwise the stored MIME type), `Content-Disposition: attachment; filename*=utf-8''<name>` (RFC 5987), `Cache-Control: no-store, private` and, when available, `Content-MD5` (base64). `<name>` is `{artifact_id}.zip` for a ZIP archive, otherwise `{artifact_id}.txt`, whatever the content is. `Content-MD5` is always on a Claude Doc's ZIP, only on a single file stored uncompressed, and never on a ZIP archive of a version's files. Check the body against it when present.
18Headers: `Content-Type` (`application/zip` for a ZIP archive, otherwise the stored MIME type), `Content-Disposition: attachment; filename*=utf-8''<name>` (RFC 5987), `Cache-Control: no-store, private` and, when available, `Content-MD5` (base64). `<name>` is `{artifact_id}.zip` for a ZIP archive, otherwise `{artifact_id}.txt`, whatever the content is. `Content-MD5` is always on a Claude Doc's or a Claude Sheet's ZIP, only on a single file stored uncompressed, and never on a ZIP archive of a version's files. Check the body against it when present.
1719
1820Errors specific to this download:
1921
from line 22
2022- `404`: the Artifact doesn't exist, or the API key cannot read it.
2123- `400` with `error.details.error_code` `cmek_key_disabled`: the organization's customer-managed encryption key can't be used, for example because it is disabled or revoked. Retry once the key can be used again.
2224- `503`: the content can't be produced right now. Wait the number of seconds in the `Retry-After` header, or retry with backoff when it is absent.
23- `422` with `multi_file_unavailable`: the request does not set `multi_file_format=zip`, and the Artifact is a Claude Doc or its latest version has more than one file. Add the parameter.
24- `422` with `file_set_unavailable`: the request sets `multi_file_format=zip`, the Artifact is not a Claude Doc, and one of the latest version's files has a path the API cannot export. Do not retry.
25- `422` with `document_unavailable`: Claude Docs has no document it can export for the Doc, for example because it has no text tab or is in the trash. Retrying will not help unless that changes.
26- `422` with `document_too_large`: the Doc's export is over 16 MiB. Do not retry.
25- `422` with `multi_file_unavailable`: the request does not set `multi_file_format=zip`, and the Artifact is a Claude Doc or a Claude Sheet, or its latest version has more than one file. Add the parameter.
26- `422` with `file_set_unavailable`: the request sets `multi_file_format=zip`, the Artifact is neither a Claude Doc nor a Claude Sheet, and one of the latest version's files has a path the API cannot export. Do not retry.
27- `422` with `document_unavailable`: Claude Docs has no document it can export for the Doc, for example because it has no text tab or is in the trash. For a Claude Sheet, nothing can be returned as an .xlsx file, for example because the Sheet is in the trash. Retrying will not help unless that changes.
28- `422` with `document_too_large`: the Doc's or the Sheet's export is over 16 MiB. Do not retry.
2729- `422` with `cmek_org_unsupported`: the organization uses customer-managed encryption keys and the export can't be served for it right now. Try again later, and contact Anthropic support if this continues.
2830
2931An error after the download has started stops the body early, with the `200` status already sent. For example, this happens to content stored compressed when it is over 16 MiB once decompressed. For a single file with no `Content-MD5`, the only sign is a transfer that aborts before its last chunk, so treat a download that aborts this way as failed.
from line 53
5153
5254- `multi_file_format: optional string`
5355
54 Set to `zip`, its only value. A Claude Doc downloads only this way, as a ZIP archive of Word files, one per text tab. For any other Artifact, when the latest version has more than one file, it comes back as a ZIP archive of its files with an index, `files.json`.
56 Set to `zip`, its only value. A Claude Doc downloads only this way, as a ZIP archive of Word files, one per text tab. So does a Claude Sheet, as a ZIP archive that holds one .xlsx file. For any other Artifact, when the latest version has more than one file, it comes back as a ZIP archive of its files with an index, `files.json`.
5557
5658## Headers
5759
58- `"anthropic-version": optional string`
60- `"anthropic-version": string`
5961
60 The version of the Claude API you want to use.
62 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
6163
62 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
64 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
6365
6466- `"x-api-key": optional string`
6567
from line 69
6769
6870```bash
6971curl https://api.anthropic.com/v1/compliance/apps/code/artifacts/$ARTIFACT_ID/content \
70 -H 'anthropic-version: 2023-06-01' \
72 -H 'anthropic-version: 2026-10-21' \
7173 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
7274```
7375
api/compliance/apps/code/artifacts/list Changed · +13 / -11 lines
from line 72
7272
7373## Headers
7474
75- `"anthropic-version": optional string`
75- `"anthropic-version": string`
7676
77 The version of the Claude API you want to use.
77 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
7878
79 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
79 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
8080
8181- `"x-api-key": optional string`
8282
from line 90
9090
9191 Artifact identifier (tagged ID)
9292
93 - `artifact_type: "claude_dashboards" or "claude_design" or "claude_design_systems" or 5 more`
93 - `artifact_type: "claude_dashboards" or "claude_design" or "claude_design_systems" or 6 more`
9494
95 Which kind of Artifact this is: `code` for a site published from Claude Code, or the built-in Artifact type it was made from — `claude_docs` (Claude Docs), `claude_slides` (Slides), `claude_design` (Design), `claude_design_systems` (a design system), `claude_motion` (Motion) or `claude_dashboards` (Dashboards). `other` is an Artifact made from a built-in type this list does not name yet.
95 Which kind of Artifact this is: `code` for a site published from Claude Code, or the built-in Artifact type it was made from — `claude_docs` (Claude Docs), `claude_slides` (Slides), `claude_design` (Design), `claude_design_systems` (a design system), `claude_motion` (Motion), `claude_dashboards` (Dashboards) or `claude_sheets` (Claude Sheets). `other` is an Artifact made from a built-in type this list does not name yet.
9696
9797 - `"claude_dashboards"`
9898
from line 104
104104
105105 - `"claude_motion"`
106106
107 - `"claude_sheets"`
108
107109 - `"claude_slides"`
108110
109111 - `"code"`
from line 122
120122
121123 - `published_version_id: string or null`
122124
123 Identifier of the version a non-owner viewer would render when `read_mode` permits them — the version the owner has pinned for non-owner readers if one is pinned, otherwise the owner's latest. When `read_mode` is `owner` no non-owner renders any version; the field still reports which version would be served were read_mode widened. Null for a Claude Doc; see `versions`.
125 Identifier of the version a non-owner viewer would render when `read_mode` permits them — the version the owner has pinned for non-owner readers if one is pinned, otherwise the owner's latest. When `read_mode` is `owner` no non-owner renders any version; the field still reports which version would be served were read_mode widened. Null for a Claude Doc or a Claude Sheet; see `versions`.
124126
125127 - `read_mode: "org" or "owner" or "public" or "users"`
126128
from line 156
154156
155157 - `versions: array of object`
156158
157 Up to roughly 20 most-recently-published versions of this Artifact (older versions are not retained). Metadata only — use `GET /v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}` to download a version's content. Empty for a Claude Doc, because a Doc's versions hold only the web page that displays it, not its text. Download a Doc's text with `GET /v1/compliance/apps/code/artifacts/{artifact_id}/content?multi_file_format=zip`.
159 Up to roughly 20 most-recently-published versions of this Artifact (older versions are not retained). Metadata only — use `GET /v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}` to download a version's content. Empty for a Claude Doc or a Claude Sheet, because their versions hold only the web page that displays them, not the Doc's text or the Sheet's data. Download a Doc's text or a Sheet's data with `GET /v1/compliance/apps/code/artifacts/{artifact_id}/content?multi_file_format=zip`.
158160
159161 - `id: string`
160162
from line 184
182184
183185```bash
184186curl https://api.anthropic.com/v1/compliance/apps/code/artifacts \
185 -H 'anthropic-version: 2023-06-01' \
187 -H 'anthropic-version: 2026-10-21' \
186188 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
187189```
188190
api/compliance/apps/code/artifacts/retrieve_version Changed · +7 / -7 lines
from line 7
77
88**GET** `/v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}`
99
10Streams the content of one version of an Artifact as the response body, in chunks with no `Content-Length`. With `multi_file_format=zip`, a version with more than one file, other than a Claude Doc's (an Artifact whose `artifact_type` is `claude_docs`), comes back as a ZIP archive of its files.
10Streams the content of one version of an Artifact as the response body, in chunks with no `Content-Length`. With `multi_file_format=zip`, a version with more than one file, other than a Claude Doc's or a Claude Sheet's (an Artifact whose `artifact_type` is `claude_docs` or `claude_sheets`), comes back as a ZIP archive of its files.
1111
1212Headers: `Content-Type` (`application/zip` for a ZIP archive, otherwise the stored MIME type), `Content-Disposition: attachment; filename*=utf-8''<name>` (RFC 5987), `Cache-Control: no-store, private` and, when available, `Content-MD5` (base64). `<name>` is `{artifact_id}-{version_id}.zip` for a ZIP archive, otherwise `{artifact_id}-{version_id}.txt`, whatever the content is. `Content-MD5` is only on a single file stored uncompressed, so it is never on a ZIP archive. Check the body against it when present.
1313
from line 15
1515
1616- `404`: the Artifact doesn't exist or the API key cannot read it, or the version is no longer kept. Older versions are dropped as new ones are published, so list the Artifact's versions again. You also get this when the organization's customer-managed encryption key can't be used. Retry once the key can be used again.
1717- `503`: the content can't be served right now, for example because its upload is still in progress or was abandoned. Retry with backoff.
18- `422` with `error.details.error_code` `multi_file_unavailable`: the version has more than one file. Add `multi_file_format=zip`. A Claude Doc's version with more than one file gets this error either way, because it holds only the web page that displays the Doc. Download the Doc's text with `GET /v1/compliance/apps/code/artifacts/{artifact_id}/content?multi_file_format=zip`.
18- `422` with `error.details.error_code` `multi_file_unavailable`: the version has more than one file. Add `multi_file_format=zip`. A Claude Doc's or a Claude Sheet's version with more than one file gets this error either way, because it holds only the web page that displays the Doc or the Sheet. Download the Doc's text or the Sheet's data with `GET /v1/compliance/apps/code/artifacts/{artifact_id}/content?multi_file_format=zip`.
1919- `422` with `file_set_unavailable`: the request sets `multi_file_format=zip`, the version has more than one file, and one of them has a path the API cannot export. Do not retry.
2020
2121An error after the download has started stops the body early, with the `200` status already sent. For example, this happens to content stored compressed when it is over 16 MiB once decompressed. For a single file with no `Content-MD5`, the only sign is a transfer that aborts before its last chunk, so treat a download that aborts this way as failed.
from line 47
4747
4848- `multi_file_format: optional string`
4949
50 Set to `zip`, its only value, to receive a version that has more than one file as a ZIP archive of its files with an index, `files.json`. A version with one file is returned as that file. A Claude Doc's version never comes back as a ZIP.
50 Set to `zip`, its only value, to receive a version that has more than one file as a ZIP archive of its files with an index, `files.json`. A version with one file is returned as that file. A Claude Doc's or a Claude Sheet's version never comes back as a ZIP.
5151
5252## Headers
5353
54- `"anthropic-version": optional string`
54- `"anthropic-version": string`
5555
56 The version of the Claude API you want to use.
56 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
5757
58 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
58 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
5959
6060- `"x-api-key": optional string`
6161
from line 63
6363
6464```bash
6565curl https://api.anthropic.com/v1/compliance/apps/code/artifacts/$ARTIFACT_ID/versions/$VERSION_ID \
66 -H 'anthropic-version: 2023-06-01' \
66 -H 'anthropic-version: 2026-10-21' \
6767 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
6868```
6969
api/compliance/apps/projects Changed · +48 / -48 lines
from line 86
8686
8787### Headers
8888
89- `"anthropic-version": optional string`
89- `"anthropic-version": string`
9090
91 The version of the Claude API you want to use.
91 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
9292
93 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
93 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
9494
9595- `"x-api-key": optional string`
9696
from line 168
168168
169169```bash
170170curl https://api.anthropic.com/v1/compliance/apps/projects \
171 -H 'anthropic-version: 2023-06-01' \
171 -H 'anthropic-version: 2026-10-21' \
172172 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
173173```
174174
from line 211
211211
212212### Headers
213213
214- `"anthropic-version": optional string`
214- `"anthropic-version": string`
215215
216 The version of the Claude API you want to use.
216 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
217217
218 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
218 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
219219
220220- `"x-api-key": optional string`
221221
from line 297
297297
298298```bash
299299curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID \
300 -H 'anthropic-version: 2023-06-01' \
300 -H 'anthropic-version: 2026-10-21' \
301301 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
302302```
303303
from line 348
348348
349349### Headers
350350
351- `"anthropic-version": optional string`
351- `"anthropic-version": string`
352352
353 The version of the Claude API you want to use.
353 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
354354
355 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
355 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
356356
357357- `"x-api-key": optional string`
358358
from line 373
373373```bash
374374curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID \
375375 -X DELETE \
376 -H 'anthropic-version: 2023-06-01' \
376 -H 'anthropic-version: 2026-10-21' \
377377 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
378378```
379379
from line 581
581581
582582#### Headers
583583
584- `"anthropic-version": optional string`
584- `"anthropic-version": string`
585585
586 The version of the Claude API you want to use.
586 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
587587
588 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
588 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
589589
590590- `"x-api-key": optional string`
591591
from line 679
679679
680680```bash
681681curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID/attachments \
682 -H 'anthropic-version: 2023-06-01' \
682 -H 'anthropic-version: 2026-10-21' \
683683 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
684684```
685685
from line 736
736736
737737#### Headers
738738
739- `"anthropic-version": optional string`
739- `"anthropic-version": string`
740740
741 The version of the Claude API you want to use.
741 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
742742
743 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
743 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
744744
745745- `"x-api-key": optional string`
746746
from line 890
890890
891891```bash
892892curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID/collaborators \
893 -H 'anthropic-version: 2023-06-01' \
893 -H 'anthropic-version: 2026-10-21' \
894894 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
895895```
896896
from line 927
927927
928928#### Headers
929929
930- `"anthropic-version": optional string`
930- `"anthropic-version": string`
931931
932 The version of the Claude API you want to use.
932 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
933933
934 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
934 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
935935
936936- `"x-api-key": optional string`
937937
from line 971
971971
972972```bash
973973curl https://api.anthropic.com/v1/compliance/apps/projects/documents/$DOCUMENT_ID \
974 -H 'anthropic-version: 2023-06-01' \
974 -H 'anthropic-version: 2026-10-21' \
975975 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
976976```
977977
from line 1009
10091009
10101010#### Headers
10111011
1012- `"anthropic-version": optional string`
1012- `"anthropic-version": string`
10131013
1014 The version of the Claude API you want to use.
1014 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
10151015
1016 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
1016 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
10171017
10181018- `"x-api-key": optional string`
10191019
from line 1067
10671067
10681068```bash
10691069curl https://api.anthropic.com/v1/compliance/apps/projects/documents/$DOCUMENT_ID/metadata \
1070 -H 'anthropic-version: 2023-06-01' \
1070 -H 'anthropic-version: 2026-10-21' \
10711071 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
10721072```
10731073
from line 1105
11051105
11061106#### Headers
11071107
1108- `"anthropic-version": optional string`
1108- `"anthropic-version": string`
11091109
1110 The version of the Claude API you want to use.
1110 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
11111111
1112 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
1112 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
11131113
11141114- `"x-api-key": optional string`
11151115
from line 1130
11301130```bash
11311131curl https://api.anthropic.com/v1/compliance/apps/projects/documents/$DOCUMENT_ID \
11321132 -X DELETE \
1133 -H 'anthropic-version: 2023-06-01' \
1133 -H 'anthropic-version: 2026-10-21' \
11341134 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
11351135```
11361136
api/compliance/apps/projects/attachments Changed · +6 / -6 lines
from line 40
4040
4141### Headers
4242
43- `"anthropic-version": optional string`
43- `"anthropic-version": string`
4444
45 The version of the Claude API you want to use.
45 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
4646
47 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
47 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
4848
4949- `"x-api-key": optional string`
5050
from line 138
138138
139139```bash
140140curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID/attachments \
141 -H 'anthropic-version: 2023-06-01' \
141 -H 'anthropic-version: 2026-10-21' \
142142 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
143143```
144144
api/compliance/apps/projects/attachments/list Changed · +4 / -4 lines
from line 38
3838
3939## Headers
4040
41- `"anthropic-version": optional string`
41- `"anthropic-version": string`
4242
43 The version of the Claude API you want to use.
43 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
4444
45 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
45 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
4646
4747- `"x-api-key": optional string`
4848
from line 136
136136
137137```bash
138138curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID/attachments \
139 -H 'anthropic-version: 2023-06-01' \
139 -H 'anthropic-version: 2026-10-21' \
140140 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
141141```
142142
api/compliance/apps/projects/collaborators Changed · +6 / -6 lines
from line 36
3636
3737### Headers
3838
39- `"anthropic-version": optional string`
39- `"anthropic-version": string`
4040
41 The version of the Claude API you want to use.
41 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
4242
43 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
43 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
4444
4545- `"x-api-key": optional string`
4646
from line 190
190190
191191```bash
192192curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID/collaborators \
193 -H 'anthropic-version: 2023-06-01' \
193 -H 'anthropic-version: 2026-10-21' \
194194 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
195195```
196196
api/compliance/apps/projects/collaborators/list Changed · +6 / -6 lines
from line 34
3434
3535## Headers
3636
37- `"anthropic-version": optional string`
37- `"anthropic-version": string`
3838
39 The version of the Claude API you want to use.
39 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
4040
41 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
41 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
4242
4343- `"x-api-key": optional string`
4444
from line 188
188188
189189```bash
190190curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID/collaborators \
191 -H 'anthropic-version: 2023-06-01' \
191 -H 'anthropic-version: 2026-10-21' \
192192 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
193193```
194194
api/compliance/apps/projects/delete Changed · +4 / -4 lines
from line 26
2626
2727## Headers
2828
29- `"anthropic-version": optional string`
29- `"anthropic-version": string`
3030
31 The version of the Claude API you want to use.
31 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
3232
33 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
33 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
3434
3535- `"x-api-key": optional string`
3636
from line 51
5151```bash
5252curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID \
5353 -X DELETE \
54 -H 'anthropic-version: 2023-06-01' \
54 -H 'anthropic-version: 2026-10-21' \
5555 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
5656```
5757
api/compliance/apps/projects/documents Changed · +18 / -18 lines
from line 19
1919
2020### Headers
2121
22- `"anthropic-version": optional string`
22- `"anthropic-version": string`
2323
24 The version of the Claude API you want to use.
24 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
2525
26 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
26 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
2727
2828- `"x-api-key": optional string`
2929
from line 63
6363
6464```bash
6565curl https://api.anthropic.com/v1/compliance/apps/projects/documents/$DOCUMENT_ID \
66 -H 'anthropic-version: 2023-06-01' \
66 -H 'anthropic-version: 2026-10-21' \
6767 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
6868```
6969
from line 101
101101
102102### Headers
103103
104- `"anthropic-version": optional string`
104- `"anthropic-version": string`
105105
106 The version of the Claude API you want to use.
106 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
107107
108 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
108 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
109109
110110- `"x-api-key": optional string`
111111
from line 159
159159
160160```bash
161161curl https://api.anthropic.com/v1/compliance/apps/projects/documents/$DOCUMENT_ID/metadata \
162 -H 'anthropic-version: 2023-06-01' \
162 -H 'anthropic-version: 2026-10-21' \
163163 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
164164```
165165
from line 197
197197
198198### Headers
199199
200- `"anthropic-version": optional string`
200- `"anthropic-version": string`
201201
202 The version of the Claude API you want to use.
202 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
203203
204 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
204 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
205205
206206- `"x-api-key": optional string`
207207
from line 222
222222```bash
223223curl https://api.anthropic.com/v1/compliance/apps/projects/documents/$DOCUMENT_ID \
224224 -X DELETE \
225 -H 'anthropic-version: 2023-06-01' \
225 -H 'anthropic-version: 2026-10-21' \
226226 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
227227```
228228
api/compliance/apps/projects/documents/delete Changed · +4 / -4 lines
from line 19
1919
2020## Headers
2121
22- `"anthropic-version": optional string`
22- `"anthropic-version": string`
2323
24 The version of the Claude API you want to use.
24 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
2525
26 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
26 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
2727
2828- `"x-api-key": optional string`
2929
from line 44
4444```bash
4545curl https://api.anthropic.com/v1/compliance/apps/projects/documents/$DOCUMENT_ID \
4646 -X DELETE \
47 -H 'anthropic-version: 2023-06-01' \
47 -H 'anthropic-version: 2026-10-21' \
4848 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
4949```
5050
api/compliance/apps/projects/documents/metadata Changed · +4 / -4 lines
from line 22
2222
2323## Headers
2424
25- `"anthropic-version": optional string`
25- `"anthropic-version": string`
2626
27 The version of the Claude API you want to use.
27 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
2828
29 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
29 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
3030
3131- `"x-api-key": optional string`
3232
from line 80
8080
8181```bash
8282curl https://api.anthropic.com/v1/compliance/apps/projects/documents/$DOCUMENT_ID/metadata \
83 -H 'anthropic-version: 2023-06-01' \
83 -H 'anthropic-version: 2026-10-21' \
8484 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
8585```
8686
api/compliance/apps/projects/documents/retrieve Changed · +4 / -4 lines
from line 17
1717
1818## Headers
1919
20- `"anthropic-version": optional string`
20- `"anthropic-version": string`
2121
22 The version of the Claude API you want to use.
22 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
2323
24 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
24 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
2525
2626- `"x-api-key": optional string`
2727
from line 61
6161
6262```bash
6363curl https://api.anthropic.com/v1/compliance/apps/projects/documents/$DOCUMENT_ID \
64 -H 'anthropic-version: 2023-06-01' \
64 -H 'anthropic-version: 2026-10-21' \
6565 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
6666```
6767
api/compliance/apps/projects/list Changed · +4 / -4 lines
from line 84
8484
8585## Headers
8686
87- `"anthropic-version": optional string`
87- `"anthropic-version": string`
8888
89 The version of the Claude API you want to use.
89 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
9090
91 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
91 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
9292
9393- `"x-api-key": optional string`
9494
from line 166
166166
167167```bash
168168curl https://api.anthropic.com/v1/compliance/apps/projects \
169 -H 'anthropic-version: 2023-06-01' \
169 -H 'anthropic-version: 2026-10-21' \
170170 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
171171```
172172
api/compliance/apps/projects/retrieve Changed · +4 / -4 lines
from line 17
1717
1818## Headers
1919
20- `"anthropic-version": optional string`
20- `"anthropic-version": string`
2121
22 The version of the Claude API you want to use.
22 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
2323
24 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
24 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
2525
2626- `"x-api-key": optional string`
2727
from line 103
103103
104104```bash
105105curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID \
106 -H 'anthropic-version: 2023-06-01' \
106 -H 'anthropic-version: 2026-10-21' \
107107 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
108108```
109109
api/compliance/apps/sessions Changed · +30 / -30 lines
from line 64
6464
6565#### Headers
6666
67- `"anthropic-version": optional string`
67- `"anthropic-version": string`
6868
69 The version of the Claude API you want to use.
69 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
7070
71 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
71 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
7272
7373- `"x-api-key": optional string`
7474
from line 136
136136
137137```bash
138138curl https://api.anthropic.com/v1/compliance/apps/sessions/local \
139 -H 'anthropic-version: 2023-06-01' \
139 -H 'anthropic-version: 2026-10-21' \
140140 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
141141```
142142
from line 179
179179
180180#### Headers
181181
182- `"anthropic-version": optional string`
182- `"anthropic-version": string`
183183
184 The version of the Claude API you want to use.
184 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
185185
186 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
186 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
187187
188188- `"x-api-key": optional string`
189189
from line 243
243243
244244```bash
245245curl https://api.anthropic.com/v1/compliance/apps/sessions/local/$LOCAL_SESSION_ID \
246 -H 'anthropic-version: 2023-06-01' \
246 -H 'anthropic-version: 2026-10-21' \
247247 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
248248```
249249
from line 328
328328
329329#### Headers
330330
331- `"anthropic-version": optional string`
331- `"anthropic-version": string`
332332
333 The version of the Claude API you want to use.
333 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
334334
335 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
335 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
336336
337337- `"x-api-key": optional string`
338338
from line 562
562562
563563```bash
564564curl https://api.anthropic.com/v1/compliance/apps/sessions/local/$LOCAL_SESSION_ID/messages \
565 -H 'anthropic-version: 2023-06-01' \
565 -H 'anthropic-version: 2026-10-21' \
566566 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
567567```
568568
from line 690
690690
691691#### Headers
692692
693- `"anthropic-version": optional string`
693- `"anthropic-version": string`
694694
695 The version of the Claude API you want to use.
695 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
696696
697 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
697 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
698698
699699- `"x-api-key": optional string`
700700
from line 770
770770
771771```bash
772772curl https://api.anthropic.com/v1/compliance/apps/sessions/remote \
773 -H 'anthropic-version: 2023-06-01' \
773 -H 'anthropic-version: 2026-10-21' \
774774 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
775775```
776776
from line 872
872872
873873#### Headers
874874
875- `"anthropic-version": optional string`
875- `"anthropic-version": string`
876876
877 The version of the Claude API you want to use.
877 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
878878
879 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
879 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
880880
881881- `"x-api-key": optional string`
882882
from line 1072
10721072
10731073```bash
10741074curl https://api.anthropic.com/v1/compliance/apps/sessions/remote/$CLAUDE_REMOTE_SESSION_ID/messages \
1075 -H 'anthropic-version: 2023-06-01' \
1075 -H 'anthropic-version: 2026-10-21' \
10761076 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
10771077```
10781078
api/compliance/apps/sessions/local Changed · +18 / -18 lines
from line 62
6262
6363### Headers
6464
65- `"anthropic-version": optional string`
65- `"anthropic-version": string`
6666
67 The version of the Claude API you want to use.
67 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
6868
69 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
69 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
7070
7171- `"x-api-key": optional string`
7272
from line 134
134134
135135```bash
136136curl https://api.anthropic.com/v1/compliance/apps/sessions/local \
137 -H 'anthropic-version: 2023-06-01' \
137 -H 'anthropic-version: 2026-10-21' \
138138 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
139139```
140140
from line 177
177177
178178### Headers
179179
180- `"anthropic-version": optional string`
180- `"anthropic-version": string`
181181
182 The version of the Claude API you want to use.
182 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
183183
184 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
184 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
185185
186186- `"x-api-key": optional string`
187187
from line 241
241241
242242```bash
243243curl https://api.anthropic.com/v1/compliance/apps/sessions/local/$LOCAL_SESSION_ID \
244 -H 'anthropic-version: 2023-06-01' \
244 -H 'anthropic-version: 2026-10-21' \
245245 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
246246```
247247
from line 442
442442
443443#### Headers
444444
445- `"anthropic-version": optional string`
445- `"anthropic-version": string`
446446
447 The version of the Claude API you want to use.
447 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
448448
449 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
449 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
450450
451451- `"x-api-key": optional string`
452452
from line 676
676676
677677```bash
678678curl https://api.anthropic.com/v1/compliance/apps/sessions/local/$LOCAL_SESSION_ID/messages \
679 -H 'anthropic-version: 2023-06-01' \
679 -H 'anthropic-version: 2026-10-21' \
680680 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
681681```
682682
api/compliance/apps/sessions/local/list Changed · +4 / -4 lines
from line 60
6060
6161## Headers
6262
63- `"anthropic-version": optional string`
63- `"anthropic-version": string`
6464
65 The version of the Claude API you want to use.
65 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
6666
67 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
67 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
6868
6969- `"x-api-key": optional string`
7070
from line 132
132132
133133```bash
134134curl https://api.anthropic.com/v1/compliance/apps/sessions/local \
135 -H 'anthropic-version: 2023-06-01' \
135 -H 'anthropic-version: 2026-10-21' \
136136 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
137137```
138138
api/compliance/apps/sessions/local/messages Changed · +6 / -6 lines
from line 66
6666
6767### Headers
6868
69- `"anthropic-version": optional string`
69- `"anthropic-version": string`
7070
71 The version of the Claude API you want to use.
71 The version of the Claude API to use. Send an available version on every request. Some other Compliance API endpoints return a 400 error for a request that omits this header, or sends a value that is not an available version. This endpoint treats such a request as version `2023-06-01`.
7272
73 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
73 See [API versions](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http) for the available versions.
7474
7575- `"x-api-key": optional string`
7676
from line 300
300300
301301```bash
302302curl https://api.anthropic.com/v1/compliance/apps/sessions/local/$LOCAL_SESSION_ID/messages \
303 -H 'anthropic-version: 2023-06-01' \
303 -H 'anthropic-version: 2026-10-21' \
304304 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
305305```
306306