One read of Claude Developer Platformapi-20261012T063709Z
394 pages moved out of 760 read.
Pages moved
394
significant first
Pages read
760
in this capture
Captured
06:37 UTC
Corpus hash
a680f764ff92
corpus-hash
What this read moved
51-75 of 394, page 3 of 16This capture is too large to show at once. Changes 51-75 of 394 are below, significant first; the rest are on the following screens.
api/beta/sessions/events/stream Changed · +3 / -3 lines
from line 351
351351
352352 - `tool_use_id: string`
353353
354 The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
354 The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
355355
356356 - `deny_message: optional string or null`
357357
from line 381
381381
382382 - `custom_tool_use_id: string`
383383
384 The id of the `agent.custom_tool_use` event this result corresponds to. It is also listed in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
384 The id of the `agent.custom_tool_use` event this result corresponds to. It is also listed in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
385385
386386 - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock`
387387
from line 1749
17491749
17501750 - `tool_use_id: string`
17511751
1752 The id of the `agent.tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
1752 The id of the `agent.tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
17531753
17541754 - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock`
17551755
api/beta/sessions/threads Changed · +9 / -9 lines
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
from line 4904
49044904
49054905 - `tool_use_id: string`
49064906
4907 The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
4907 The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
49084908
49094909 - `deny_message: optional string or null`
49104910
from line 4934
49344934
49354935 - `custom_tool_use_id: string`
49364936
4937 The id of the `agent.custom_tool_use` event this result corresponds to. It is also listed in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
4937 The id of the `agent.custom_tool_use` event this result corresponds to. It is also listed in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
49384938
49394939 - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock`
49404940
from line 6302
63026302
63036303 - `tool_use_id: string`
63046304
6305 The id of the `agent.tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
6305 The id of the `agent.tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
63066306
63076307 - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock`
63086308
from line 7986
79867986
79877987 - `tool_use_id: string`
79887988
7989 The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
7989 The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
79907990
79917991 - `deny_message: optional string or null`
79927992
from line 8016
80168016
80178017 - `custom_tool_use_id: string`
80188018
8019 The id of the `agent.custom_tool_use` event this result corresponds to. It is also listed in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
8019 The id of the `agent.custom_tool_use` event this result corresponds to. It is also listed in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
80208020
80218021 - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock`
80228022
from line 8210
82108210
82118211 The resolved permission_policy was always_ask; accompanies evaluated_permission "ask".
82128212
8213 - `type: "always_ask"`
82148213
8215 - `BetaManagedAgentsAgentToolEvaluationAuto object`
8216
8217
api/beta/sessions/threads/events Changed · +6 / -6 lines
from line 353
353353
354354 - `tool_use_id: string`
355355
356 The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
356 The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
357357
358358 - `deny_message: optional string or null`
359359
from line 383
383383
384384 - `custom_tool_use_id: string`
385385
386 The id of the `agent.custom_tool_use` event this result corresponds to. It is also listed in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
386 The id of the `agent.custom_tool_use` event this result corresponds to. It is also listed in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
387387
388388 - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock`
389389
from line 1751
17511751
17521752 - `tool_use_id: string`
17531753
1754 The id of the `agent.tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
1754 The id of the `agent.tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
17551755
17561756 - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock`
17571757
from line 3430
34303430
34313431 - `tool_use_id: string`
34323432
3433 The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
3433 The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
34343434
34353435 - `deny_message: optional string or null`
34363436
from line 3460
34603460
34613461 - `custom_tool_use_id: string`
34623462
3463 The id of the `agent.custom_tool_use` event this result corresponds to. It is also listed in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
3463 The id of the `agent.custom_tool_use` event this result corresponds to. It is also listed in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
34643464
34653465 - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock`
34663466
from line 4828
48284828
48294829 - `tool_use_id: string`
48304830
4831 The id of the `agent.tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
4831 The id of the `agent.tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
48324832
48334833 - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock`
48344834
api/beta/sessions/threads/events/list Changed · +3 / -3 lines
from line 351
351351
352352 - `tool_use_id: string`
353353
354 The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
354 The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
355355
356356 - `deny_message: optional string or null`
357357
from line 381
381381
382382 - `custom_tool_use_id: string`
383383
384 The id of the `agent.custom_tool_use` event this result corresponds to. It is also listed in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
384 The id of the `agent.custom_tool_use` event this result corresponds to. It is also listed in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
385385
386386 - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock`
387387
from line 1749
17491749
17501750 - `tool_use_id: string`
17511751
1752 The id of the `agent.tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
1752 The id of the `agent.tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
17531753
17541754 - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock`
17551755
api/beta/sessions/threads/events/stream Changed · +3 / -3 lines
from line 353
353353
354354 - `tool_use_id: string`
355355
356 The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
356 The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
357357
358358 - `deny_message: optional string or null`
359359
from line 383
383383
384384 - `custom_tool_use_id: string`
385385
386 The id of the `agent.custom_tool_use` event this result corresponds to. It is also listed in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
386 The id of the `agent.custom_tool_use` event this result corresponds to. It is also listed in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
387387
388388 - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock`
389389
from line 1751
17511751
17521752 - `tool_use_id: string`
17531753
1754 The id of the `agent.tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
1754 The id of the `agent.tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
17551755
17561756 - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock`
17571757
api/beta/skills Changed · +9 / -9 lines
from line 17
1717
1818 The version of the Claude API you want to use.
1919
20 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
20 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
2121
2222- `"anthropic-beta": optional array of AnthropicBeta`
2323
from line 278
278278
279279 The version of the Claude API you want to use.
280280
281 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
281 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
282282
283283- `"anthropic-beta": optional array of AnthropicBeta`
284284
from line 519
519519
520520 The version of the Claude API you want to use.
521521
522 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
522 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
523523
524524- `"anthropic-beta": optional array of AnthropicBeta`
525525
from line 747
747747
748748 The version of the Claude API you want to use.
749749
750 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
750 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
751751
752752- `"anthropic-beta": optional array of AnthropicBeta`
753753
from line 1032
10321032
10331033 The version of the Claude API you want to use.
10341034
1035 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1035 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
10361036
10371037- `"anthropic-beta": optional array of AnthropicBeta`
10381038
from line 1253
12531253
12541254 The version of the Claude API you want to use.
12551255
1256 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1256 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
12571257
12581258- `"anthropic-beta": optional array of AnthropicBeta`
12591259
from line 1469
14691469
14701470 The version of the Claude API you want to use.
14711471
1472 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1472 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
14731473
14741474- `"anthropic-beta": optional array of AnthropicBeta`
14751475
from line 1617
16171617
16181618 The version of the Claude API you want to use.
16191619
1620 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1620 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
16211621
16221622- `"anthropic-beta": optional array of AnthropicBeta`
16231623
from line 1820
18201820
18211821 The version of the Claude API you want to use.
18221822
1823 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1823 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
18241824
18251825- `"anthropic-beta": optional array of AnthropicBeta`
18261826
api/beta/skills/versions Changed · +5 / -5 lines
from line 25
2525
2626 The version of the Claude API you want to use.
2727
28 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
28 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
2929
3030- `"anthropic-beta": optional array of AnthropicBeta`
3131
from line 246
246246
247247 The version of the Claude API you want to use.
248248
249 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
249 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
250250
251251- `"anthropic-beta": optional array of AnthropicBeta`
252252
from line 462
462462
463463 The version of the Claude API you want to use.
464464
465 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
465 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
466466
467467- `"anthropic-beta": optional array of AnthropicBeta`
468468
from line 610
610610
611611 The version of the Claude API you want to use.
612612
613 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
613 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
614614
615615- `"anthropic-beta": optional array of AnthropicBeta`
616616
from line 813
813813
814814 The version of the Claude API you want to use.
815815
816 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
816 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
817817
818818- `"anthropic-beta": optional array of AnthropicBeta`
819819
api/completions Changed · +6 / -6 lines
from line 13
1313
1414[Legacy] Create a Text Completion.
1515
16The Text Completions API is a legacy API. We recommend using the [Messages API](https://platform.claude.com/docs/en/api/messages) going forward.
16The Text Completions API is a legacy API. We recommend using the [Messages API](https://platform.claude.com/docs/en/api/messages?sdk_languages=http) going forward.
1717
18Future models and features will not be compatible with Text Completions. See our [migration guide](https://platform.claude.com/docs/en/build-with-claude/working-with-messages) for guidance in migrating from Text Completions to Messages.
18Future models and features will not be compatible with Text Completions. See our [migration guide](https://platform.claude.com/docs/en/build-with-claude/working-with-messages?sdk_languages=http) for guidance in migrating from Text Completions to Messages.
1919
2020### Headers
2121
from line 23
2323
2424 The version of the Claude API you want to use.
2525
26 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
26 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
2727
2828- `"anthropic-workspace-id": optional string`
2929
from line 257
257257 Assistant:"
258258 ```
259259
260 See [prompt validation](https://platform.claude.com/docs/en/build-with-claude/working-with-messages) and our guide to [prompt design](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/overview) for more details.
260 See [prompt validation](https://platform.claude.com/docs/en/build-with-claude/working-with-messages?sdk_languages=http) and our guide to [prompt design](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/overview?sdk_languages=http) for more details.
261261
262262 minLength: 1
263263
from line 285
285285
286286 Whether to incrementally stream the response using server-sent events.
287287
288 See [streaming](https://platform.claude.com/docs/en/build-with-claude/streaming) for details.
288 See [streaming](https://platform.claude.com/docs/en/build-with-claude/streaming?sdk_languages=http) for details.
289289
290290- `temperature: optional number`
291291
api/completions/create Changed · +6 / -6 lines
from line 11
1111
1212[Legacy] Create a Text Completion.
1313
14The Text Completions API is a legacy API. We recommend using the [Messages API](https://platform.claude.com/docs/en/api/messages) going forward.
14The Text Completions API is a legacy API. We recommend using the [Messages API](https://platform.claude.com/docs/en/api/messages?sdk_languages=http) going forward.
1515
16Future models and features will not be compatible with Text Completions. See our [migration guide](https://platform.claude.com/docs/en/build-with-claude/working-with-messages) for guidance in migrating from Text Completions to Messages.
16Future models and features will not be compatible with Text Completions. See our [migration guide](https://platform.claude.com/docs/en/build-with-claude/working-with-messages?sdk_languages=http) for guidance in migrating from Text Completions to Messages.
1717
1818## Headers
1919
from line 21
2121
2222 The version of the Claude API you want to use.
2323
24 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
24 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
2525
2626- `"anthropic-workspace-id": optional string`
2727
from line 255
255255 Assistant:"
256256 ```
257257
258 See [prompt validation](https://platform.claude.com/docs/en/build-with-claude/working-with-messages) and our guide to [prompt design](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/overview) for more details.
258 See [prompt validation](https://platform.claude.com/docs/en/build-with-claude/working-with-messages?sdk_languages=http) and our guide to [prompt design](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/overview?sdk_languages=http) for more details.
259259
260260 minLength: 1
261261
from line 283
283283
284284 Whether to incrementally stream the response using server-sent events.
285285
286 See [streaming](https://platform.claude.com/docs/en/build-with-claude/streaming) for details.
286 See [streaming](https://platform.claude.com/docs/en/build-with-claude/streaming?sdk_languages=http) for details.
287287
288288- `temperature: optional number`
289289
api/compliance Changed · +36 / -36 lines
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
from line 4281
42814281
42824282 The version of the Claude API you want to use.
42834283
4284 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
4284 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
42854285
42864286- `"x-api-key": optional string`
42874287
from line 9635
96359635
96369636 The provider's verified identifier for the caller; its form depends on the provider.
96379637
9638 - `user_agent: optional string or null`
9639
9640 - `
9638 - `user_agent: optional string
api/compliance/apps Changed · +23 / -23 lines
from line 127
127127
128128 The version of the Claude API you want to use.
129129
130 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
130 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
131131
132132- `"x-api-key": optional string`
133133
from line 268
268268
269269 The version of the Claude API you want to use.
270270
271 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
271 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
272272
273273- `"x-api-key": optional string`
274274
from line 412
412412
413413 The version of the Claude API you want to use.
414414
415 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
415 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
416416
417417- `"x-api-key": optional string`
418418
from line 845
845845
846846 The version of the Claude API you want to use.
847847
848 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
848 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
849849
850850- `"x-api-key": optional string`
851851
from line 931
931931
932932 The version of the Claude API you want to use.
933933
934 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
934 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
935935
936936- `"x-api-key": optional string`
937937
from line 983
983983
984984 The version of the Claude API you want to use.
985985
986 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
986 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
987987
988988- `"x-api-key": optional string`
989989
from line 1017
10171017
10181018 The version of the Claude API you want to use.
10191019
1020 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1020 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
10211021
10221022- `"x-api-key": optional string`
10231023
from line 1093
10931093
10941094 The version of the Claude API you want to use.
10951095
1096 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1096 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
10971097
10981098- `"x-api-key": optional string`
10991099
from line 1192
11921192
11931193 The version of the Claude API you want to use.
11941194
1195 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1195 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
11961196
11971197- `"x-api-key": optional string`
11981198
from line 1312
13121312
13131313 The version of the Claude API you want to use.
13141314
1315 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1315 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
13161316
13171317- `"x-api-key": optional string`
13181318
from line 1444
14441444
14451445 The version of the Claude API you want to use.
14461446
1447 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1447 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
14481448
14491449- `"x-api-key": optional string`
14501450
from line 1519
15191519
15201520 The version of the Claude API you want to use.
15211521
1522 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1522 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
15231523
15241524- `"x-api-key": optional string`
15251525
from line 1674
16741674
16751675 The version of the Claude API you want to use.
16761676
1677 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1677 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
16781678
16791679- `"x-api-key": optional string`
16801680
from line 1865
18651865
18661866 The version of the Claude API you want to use.
18671867
1868 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1868 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
18691869
18701870- `"x-api-key": optional string`
18711871
from line 1947
19471947
19481948 The version of the Claude API you want to use.
19491949
1950 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1950 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
19511951
19521952- `"x-api-key": optional string`
19531953
from line 2043
20432043
20442044 The version of the Claude API you want to use.
20452045
2046 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2046 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
20472047
20482048- `"x-api-key": optional string`
20492049
from line 2102
21022102
21032103 The version of the Claude API you want to use.
21042104
2105 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2105 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
21062106
21072107- `"x-api-key": optional string`
21082108
from line 2185
21852185
21862186 The version of the Claude API you want to use.
21872187
2188 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2188 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
21892189
21902190- `"x-api-key": optional string`
21912191
from line 2248
22482248
22492249 The version of the Claude API you want to use.
22502250
2251 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2251 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
22522252
22532253- `"x-api-key": optional string`
22542254
from line 2363
23632363
23642364 The version of the Claude API you want to use.
23652365
2366 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2366 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
23672367
23682368- `"x-api-key": optional string`
23692369
from line 2512
25122512
25132513 The version of the Claude API you want to use.
25142514
2515 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2515 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
25162516
25172517- `"x-api-key": optional string`
25182518
from line 2868
28682868
28692869 The version of the Claude API you want to use.
28702870
2871 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2871 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
28722872
28732873- `"x-api-key": optional string`
28742874
from line 3044
30443044
30453045 The version of the Claude API you want to use.
30463046
3047 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
3047 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
30483048
30493049- `"x-api-key": optional string`
30503050
api/compliance/apps/chats Changed · +8 / -8 lines
from line 125
125125
126126 The version of the Claude API you want to use.
127127
128 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
128 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
129129
130130- `"x-api-key": optional string`
131131
from line 266
266266
267267 The version of the Claude API you want to use.
268268
269 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
269 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
270270
271271- `"x-api-key": optional string`
272272
from line 494
494494
495495 The version of the Claude API you want to use.
496496
497 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
497 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
498498
499499- `"x-api-key": optional string`
500500
from line 927
927927
928928 The version of the Claude API you want to use.
929929
930 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
930 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
931931
932932- `"x-api-key": optional string`
933933
from line 1013
10131013
10141014 The version of the Claude API you want to use.
10151015
1016 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1016 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
10171017
10181018- `"x-api-key": optional string`
10191019
from line 1065
10651065
10661066 The version of the Claude API you want to use.
10671067
1068 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1068 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
10691069
10701070- `"x-api-key": optional string`
10711071
from line 1099
10991099
11001100 The version of the Claude API you want to use.
11011101
1102 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1102 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
11031103
11041104- `"x-api-key": optional string`
11051105
from line 1175
11751175
11761176 The version of the Claude API you want to use.
11771177
1178 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1178 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
11791179
11801180- `"x-api-key": optional string`
11811181
api/compliance/apps/chats/files Changed · +3 / -3 lines
from line 25
2525
2626 The version of the Claude API you want to use.
2727
28 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
28 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
2929
3030- `"x-api-key": optional string`
3131
from line 111
111111
112112 The version of the Claude API you want to use.
113113
114 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
114 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
115115
116116- `"x-api-key": optional string`
117117
from line 163
163163
164164 The version of the Claude API you want to use.
165165
166 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
166 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
167167
168168- `"x-api-key": optional string`
169169
api/compliance/apps/projects Changed · +8 / -8 lines
from line 90
9090
9191 The version of the Claude API you want to use.
9292
93 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
93 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
9494
9595- `"x-api-key": optional string`
9696
from line 210
210210
211211 The version of the Claude API you want to use.
212212
213 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
213 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
214214
215215- `"x-api-key": optional string`
216216
from line 342
342342
343343 The version of the Claude API you want to use.
344344
345 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
345 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
346346
347347- `"x-api-key": optional string`
348348
from line 567
567567
568568 The version of the Claude API you want to use.
569569
570 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
570 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
571571
572572- `"x-api-key": optional string`
573573
from line 722
722722
723723 The version of the Claude API you want to use.
724724
725 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
725 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
726726
727727- `"x-api-key": optional string`
728728
from line 913
913913
914914 The version of the Claude API you want to use.
915915
916 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
916 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
917917
918918- `"x-api-key": optional string`
919919
from line 995
995995
996996 The version of the Claude API you want to use.
997997
998 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
998 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
999999
10001000- `"x-api-key": optional string`
10011001
from line 1091
10911091
10921092 The version of the Claude API you want to use.
10931093
1094 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1094 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
10951095
10961096- `"x-api-key": optional string`
10971097
api/compliance/apps/projects/documents Changed · +3 / -3 lines
from line 23
2323
2424 The version of the Claude API you want to use.
2525
26 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
26 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
2727
2828- `"x-api-key": optional string`
2929
from line 105
105105
106106 The version of the Claude API you want to use.
107107
108 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
108 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
109109
110110- `"x-api-key": optional string`
111111
from line 201
201201
202202 The version of the Claude API you want to use.
203203
204 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
204 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
205205
206206- `"x-api-key": optional string`
207207
api/compliance/apps/sessions Changed · +5 / -5 lines
from line 56
5656
5757 The version of the Claude API you want to use.
5858
59 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
59 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
6060
6161- `"x-api-key": optional string`
6262
from line 171
171171
172172 The version of the Claude API you want to use.
173173
174 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
174 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
175175
176176- `"x-api-key": optional string`
177177
from line 320
320320
321321 The version of the Claude API you want to use.
322322
323 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
323 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
324324
325325- `"x-api-key": optional string`
326326
from line 676
676676
677677 The version of the Claude API you want to use.
678678
679 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
679 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
680680
681681- `"x-api-key": optional string`
682682
from line 852
852852
853853 The version of the Claude API you want to use.
854854
855 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
855 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
856856
857857- `"x-api-key": optional string`
858858
api/compliance/apps/sessions/local Changed · +3 / -3 lines
from line 54
5454
5555 The version of the Claude API you want to use.
5656
57 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
57 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
5858
5959- `"x-api-key": optional string`
6060
from line 169
169169
170170 The version of the Claude API you want to use.
171171
172 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
172 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
173173
174174- `"x-api-key": optional string`
175175
from line 434
434434
435435 The version of the Claude API you want to use.
436436
437 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
437 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
438438
439439- `"x-api-key": optional string`
440440
api/compliance/code Changed · +3 / -3 lines
from line 80
8080
8181 The version of the Claude API you want to use.
8282
83 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
83 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
8484
8585- `"x-api-key": optional string`
8686
from line 255
255255
256256 The version of the Claude API you want to use.
257257
258 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
258 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
259259
260260- `"x-api-key": optional string`
261261
from line 292
292292
293293 The version of the Claude API you want to use.
294294
295 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
295 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
296296
297297- `"x-api-key": optional string`
298298
api/compliance/code/artifacts Changed · +3 / -3 lines
from line 78
7878
7979 The version of the Claude API you want to use.
8080
81 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
81 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
8282
8383- `"x-api-key": optional string`
8484
from line 253
253253
254254 The version of the Claude API you want to use.
255255
256 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
256 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
257257
258258- `"x-api-key": optional string`
259259
from line 290
290290
291291 The version of the Claude API you want to use.
292292
293 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
293 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
294294
295295- `"x-api-key": optional string`
296296
api/compliance/groups Changed · +3 / -3 lines
from line 35
3535
3636 The version of the Claude API you want to use.
3737
38 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
38 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
3939
4040- `"x-api-key": optional string`
4141
from line 134
134134
135135 The version of the Claude API you want to use.
136136
137 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
137 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
138138
139139- `"x-api-key": optional string`
140140
from line 307
307307
308308 The version of the Claude API you want to use.
309309
310 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
310 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
311311
312312- `"x-api-key": optional string`
313313
api/compliance/organizations Changed · +6 / -6 lines
from line 33
3333
3434 The version of the Claude API you want to use.
3535
36 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
36 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
3737
3838- `"x-api-key": optional string`
3939
from line 139
139139
140140 The version of the Claude API you want to use.
141141
142 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
142 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
143143
144144- `"x-api-key": optional string`
145145
from line 259
259259
260260 The version of the Claude API you want to use.
261261
262 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
262 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
263263
264264- `"x-api-key": optional string`
265265
from line 349
349349
350350 The version of the Claude API you want to use.
351351
352 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
352 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
353353
354354- `"x-api-key": optional string`
355355
from line 435
435435
436436 The version of the Claude API you want to use.
437437
438 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
438 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
439439
440440- `"x-api-key": optional string`
441441
from line 525
525525
526526 The version of the Claude API you want to use.
527527
528 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
528 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
529529
530530- `"x-api-key": optional string`
531531
api/compliance/organizations/roles Changed · +3 / -3 lines
from line 35
3535
3636 The version of the Claude API you want to use.
3737
38 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
38 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
3939
4040- `"x-api-key": optional string`
4141
from line 125
125125
126126 The version of the Claude API you want to use.
127127
128 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
128 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
129129
130130- `"x-api-key": optional string`
131131
from line 273
273273
274274 The version of the Claude API you want to use.
275275
276 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
276 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
277277
278278- `"x-api-key": optional string`
279279
api/files Changed · +5 / -5 lines
from line 17
1717
1818 The version of the Claude API you want to use.
1919
20 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
20 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
2121
2222- `"anthropic-workspace-id": optional string`
2323
from line 146
146146
147147 The version of the Claude API you want to use.
148148
149 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
149 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
150150
151151- `"anthropic-workspace-id": optional string`
152152
from line 258
258258
259259 The version of the Claude API you want to use.
260260
261 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
261 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
262262
263263- `"anthropic-workspace-id": optional string`
264264
from line 292
292292
293293 The version of the Claude API you want to use.
294294
295 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
295 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
296296
297297- `"anthropic-workspace-id": optional string`
298298
from line 393
393393
394394 The version of the Claude API you want to use.
395395
396 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
396 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
397397
398398- `"anthropic-workspace-id": optional string`
399399
api/messages Changed · +138 / -138 lines
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
from line 13
1313
1414The Messages API can be used for either single queries or stateless multi-turn conversations.
1515
16Learn more about the Messages API in our [user guide](https://platform.claude.com/docs/en/get-started)
16Learn more about the Messages API in our [user guide](https://platform.claude.com/docs/en/get-started?sdk_languages=http)
1717
1818### Headers
1919
from line 21
2121
2222 The version of the Claude API you want to use.
2323
24 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
24 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
2525
2626- `"anthropic-user-profile-id": optional string`
2727
from line 41
4141
4242 Note that our models may stop _before_ reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate.
4343
44 Set to `0` to populate the [prompt cache](https://platform.claude.com/docs/en/build-with-claude/prompt-caching#pre-warming-the-cache) without generating a response.
44 Set to `0` to populate the [prompt cache](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=http#pre-warming-the-cache) without generating a response.
4545
46 Different models have different maximum values for this parameter. See [models](https://platform.claude.com/docs/en/about-claude/models/overview) for details.
46 Different models have different maximum values for this parameter. See [models](https://platform.claude.com/docs/en/about-claude/models/overview?sdk_languages=http) for details.
4747
4848 minimum: 0
4949
from line 55
5555
5656 Each input message must be an object with a `role` and `content`. You can specify a single `user`-role message, or you can include multiple `user` and `assistant` messages.
5757
58 If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. This is called prefill. On models that don't support prefill, creating a message that ends with a partial `assistant` response returns a 400 error. See [Prefill not supported](https://platform.claude.com/docs/en/api/errors#prefill-not-supported).
58 If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. This is called prefill. On models that don't support prefill, creating a message that ends with a partial `assistant` response returns a 400 error. See [Prefill not supported](https://platform.claude.com/docs/en/api/errors?sdk_languages=http#prefill-not-supported).
5959
6060 Example with a single `user` message:
6161
from line 92
9292 {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]}
9393 ```
9494
95 See [input examples](https://platform.claude.com/docs/en/build-with-claude/working-with-messages).
95 See [input examples](https://platform.claude.com/docs/en/build-with-claude/working-with-messages?sdk_languages=http).
9696
97 Note that if you want to include a [system prompt](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices#give-claude-a-role), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API.
97 Note that if you want to include a [system prompt](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=http#give-claude-a-role), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API.
9898
9999 There is a limit of 100,000 messages in a single request.
100100
from line 127
127127 - `5m`: 5 minutes
128128 - `1h`: 1 hour
129129
130 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.
130 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=http) for details.
131131
132132 - `"5m"`
133133
from line 1257
12571257
12581258 - `format: optional JSONOutputFormat or null`
12591259
1260 A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs)
1260 A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs?sdk_languages=http)
12611261
12621262 - `type: "json_schema"`
12631263
from line 1269
12691269
12701270 Determines whether to use priority capacity (if available) or standard capacity for this request.
12711271
1272 Anthropic offers different levels of service for your API requests. See [service-tiers](https://platform.claude.com/docs/en/api/service-tiers) for details.
1272 Anthropic offers different levels of service for your API requests. See [service-tiers](https://platform.claude.com/docs/en/api/service-tiers?sdk_languages=http) for details.
12731273
12741274 - `"auto"`
12751275
from line 1287
12871287
12881288 Whether to incrementally stream the response using server-sent events. When `true`, SDKs return a raw event stream.
12891289
1290 In the TypeScript, Python and Ruby SDKs, the recommended way to stream is `messages.stream()`. It sets `stream` for you and accumulates the events into the final message. See [Streaming with SDKs](https://platform.claude.com/docs/en/build-with-claude/streaming#streaming-with-sdks) for an example in each language.
1290 In the TypeScript, Python and Ruby SDKs, the recommended way to stream is `messages.stream()`. It sets `stream` for you and accumulates the events into the final message. See [Streaming with SDKs](https://platform.claude.com/docs/en/build-with-claude/streaming?sdk_languages=http#streaming-with-sdks) for an example in each language.
12911291
12921292- `system: optional string or array of TextBlockParam`
12931293
12941294 System prompt.
12951295
1296 A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices#give-claude-a-role).
1296 A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=http#give-claude-a-role).
12971297
12981298 - `string`
12991299
from line 1317
13171317
13181318 With `{"type": "adaptive"}`, Claude decides when and how much to think. With `{"type": "enabled"}` (manual extended thinking), you set a `budget_tokens` of at least 1,024. Thinking tokens count toward your `max_tokens` limit.
13191319
1320 Which `type` values are accepted, and what happens when you omit `thinking`, depend on the model. See [thinking](https://platform.claude.com/docs/en/build-with-claude/thinking#configuring-thinking) for each model's behavior.
1320 Which `type` values are accepted, and what happens when you omit `thinking`, depend on the model. See [thinking](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=http#configuring-thinking) for each model's behavior.
13211321
13221322 - `ThinkingConfigEnabled object`
13231323
from line 1329
13291329
13301330 Must be ≥1024 and less than `max_tokens`.
13311331
1332 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.
1332 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=http) for details.
13331333
13341334 minimum: 1024
13351335
13361336 - `display: optional "summarized" or "omitted" or null`
13371337
1338 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking#controlling-thinking-display).
1338 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=http#controlling-thinking-display).
13391339
13401340 - `"summarized"`
13411341
from line 1355
13551355
13561356 - `display: optional "summarized" or "omitted" or null`
13571357
1358 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking#controlling-thinking-display).
1358 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=http#controlling-thinking-display).
13591359
13601360 - `"summarized"`
13611361
from line 1417
14171417
14181418 If you include `tools` in your API request, the model may return `tool_use` content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using `tool_result` content blocks.
14191419
1420 There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool)).
1420 There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools?sdk_languages=http), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool?sdk_languages=http)).
14211421
14221422 Each tool definition includes:
14231423
from line 1473
14731473
14741474 Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output.
14751475
1476 See our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview) for more details.
1476 See our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview?sdk_languages=http) for more details.
14771477
14781478 - `Tool object`
14791479
from line 3328
33283328
33293329 This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact.
33303330
3331 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.
3331 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=http) for details.
33323332
33333333 - `thinking: string`
33343334
from line 3346
33463346
33473347 Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation.
33483348
3349 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking#redacted-thinking-blocks) for details.
3349 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=http#redacted-thinking-blocks) for details.
33503350
33513351 - `ToolUseBlock object`
33523352
from line 4048
40484048
40494049 - `"reasoning_extraction"`
40504050
4051 The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking).
4051 The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=http).
40524052
40534053 - `"general_harms"`
40544054
from line 4522
45224522
45234523The Token Count API can be used to count the number of tokens in a Message, including tools, images, and documents, without creating it.
45244524
4525Learn more about token counting in our [user guide](https://platform.claude.com/docs/en/build-with-claude/token-counting)
4525Learn more about token counting in our [user guide](https://platform.claude.com/docs/en/build-with-claude/token-counting?sdk_languages=http)
45264526
45274527### Headers
45284528
from line 4530
45304530
45314531 The version of the Claude API you want to use.
45324532
4533 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
4533 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
45344534
45354535- `"anthropic-user-profile-id": optional string`
45364536
from line 4552
45524552
45534553 Each input message must be an object with a `role` and `content`. You can specify a single `user`-role message, or you can include multiple `user` and `assistant` messages.
45544554
4555 If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. This is called prefill. On models that don't support prefill, creating a message that ends with a partial `assistant` response returns a 400 error. See [Prefill not supported](https://platform.claude.com/docs/en/api/errors#prefill-not-supported).
4555 If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. This is called prefill. On models that don't support prefill, creating a message that ends with a partial `assistant` response returns a 400 error. See [Prefill not supported](https://platform.claude.com/docs/en/api/errors?sdk_languages=http#prefill-not-supported).
45564556
45574557 Example with a single `user` message:
45584558
from line 4589
45894589 {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]}
45904590 ```
45914591
4592 See [input examples](https://platform.claude.com/docs/en/build-with-claude/working-with-messages).
4592 See [input examples](https://platform.claude.com/docs/en/build-with-claude/working-with-messages?sdk_languages=http).
45934593
4594 Note that if you want to include a [system prompt](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices#give-claude-a-role), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API.
4594 Note that if you want to include a [system prompt](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=http#give-claude-a-role), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API.
45954595
45964596 There is a limit of 100,000 messages in a single request.
45974597
from line 4624
46244624 - `5m`: 5 minutes
46254625 - `1h`: 1 hour
46264626
4627 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.
4627 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=http) for details.
46284628
46294629 - `"5m"`
46304630
from line 5688
56885688
56895689 - `format: optional JSONOutputFormat or null`
56905690
5691 A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs)
5691 A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs?sdk_languages=http)
56925692
56935693 - `type: "json_schema"`
56945694
from line 5700
57005700
57015701 System prompt.
57025702
5703 A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices#give-claude-a-role).
5703 A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=http#give-claude-a-role).
57045704
57055705 - `string`
57065706
from line 5724
57245724
57255725 With `{"type": "adaptive"}`, Claude decides when and how much to think. With `{"type": "enabled"}` (manual extended thinking), you set a `budget_tokens` of at least 1,024. Thinking tokens count toward your `max_tokens` limit.
57265726
5727 Which `type` values are accepted, and what happens when you omit `thinking`, depend on the model. See [thinking](https://platform.claude.com/docs/en/build-with-claude/thinking#configuring-thinking) for each model's behavior.
5727 Which `type` values are accepted, and what happens when you omit `thinking`, depend on the model. See [thinking](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=http#configuring-thinking) for each model's behavior.
57285728
57295729 - `ThinkingConfigEnabled object`
57305730
from line 5736
57365736
57375737 Must be ≥1024 and less than `max_tokens`.
57385738
5739 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.
5739 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=http) for details.
57405740
57415741 minimum: 1024
57425742
57435743 - `display: optional "summarized" or "omitted" or null`
57445744
5745 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking#controlling-thinking-display).
5745 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=http#controlling-thinking-display).
57465746
57475747 - `"summarized"`
57485748
from line 5762
57625762
57635763 - `display: optional "summarized" or "omitted" or null`
57645764
5765 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking#controlling-thinking-display).
5765 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=http#controlling-thinking-display).
57665766
57675767 - `"summarized"`
57685768
from line 5824
58245824
58255825 If you include `tools` in your API request, the model may return `tool_use` content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using `tool_result` content blocks.
58265826
5827 There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool)).
5827 There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools?sdk_languages=http), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool?sdk_languages=http)).
58285828
58295829 Each tool definition includes:
58305830
from line 5880
58805880
58815881 Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output.
58825882
5883 See our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview) for more details.
5883 See our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview?sdk_languages=http) for more details.
58845884
58855885 - `Tool object`
58865886
from line 7719
77197719 - `5m`: 5 minutes
77207720 - `1h`: 1 hour
77217721
7722 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.
7722 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=http) for details.
77237723
77247724 - `"5m"`
77257725
from line 8575
85758575
85768576 - `text: string`
85778577
8578 The key or chord to hold.
8579
8580 - `tab_id: optional string or null`
8581
8582 Tab to act on. Defaults to the active tab when omitted.
8583
8584 - `name: "hold_key"`
8585
8586 - `toolset_name: "browser"`
8587
8588### Browser Hover Config
8589
8590- `BrowserHoverConfig object`
8591
8592 `hover`'s config overrides.
8593
8594 - `defer_loading: optional boolean or null`
8595
8596 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
8597
8598 - `enabled: optional boolean or null`
8599
8600 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
8601
8602### Browser Hover Input
8603
8604- `BrowserHoverInput object`
8605
8606 Move the cursor to a coordinate or ele
8578 The key or chord to ho
api/messages/batches Changed · +43 / -43 lines
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
from line 13
1313
1414The Message Batches API can be used to process multiple Messages API requests at once. Once a Message Batch is created, it begins processing immediately. Batches can take up to 24 hours to complete.
1515
16Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing)
16Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=http)
1717
1818### Headers
1919
from line 21
2121
2222 The version of the Claude API you want to use.
2323
24 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
24 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
2525
2626- `"anthropic-user-profile-id": optional string`
2727
from line 53
5353
5454 Messages API creation parameters for the individual request.
5555
56 See the [Messages API reference](https://platform.claude.com/docs/en/api/messages) for full documentation on available parameters.
56 See the [Messages API reference](https://platform.claude.com/docs/en/api/messages?sdk_languages=http) for full documentation on available parameters.
5757
5858 - `max_tokens: number`
5959
from line 61
6161
6262 Note that our models may stop _before_ reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate.
6363
64 Set to `0` to populate the [prompt cache](https://platform.claude.com/docs/en/build-with-claude/prompt-caching#pre-warming-the-cache) without generating a response.
64 Set to `0` to populate the [prompt cache](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=http#pre-warming-the-cache) without generating a response.
6565
66 Different models have different maximum values for this parameter. See [models](https://platform.claude.com/docs/en/about-claude/models/overview) for details.
66 Different models have different maximum values for this parameter. See [models](https://platform.claude.com/docs/en/about-claude/models/overview?sdk_languages=http) for details.
6767
6868 minimum: 0
6969
from line 75
7575
7676 Each input message must be an object with a `role` and `content`. You can specify a single `user`-role message, or you can include multiple `user` and `assistant` messages.
7777
78 If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. This is called prefill. On models that don't support prefill, creating a message that ends with a partial `assistant` response returns a 400 error. See [Prefill not supported](https://platform.claude.com/docs/en/api/errors#prefill-not-supported).
78 If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. This is called prefill. On models that don't support prefill, creating a message that ends with a partial `assistant` response returns a 400 error. See [Prefill not supported](https://platform.claude.com/docs/en/api/errors?sdk_languages=http#prefill-not-supported).
7979
8080 Example with a single `user` message:
8181
from line 112
112112 {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]}
113113 ```
114114
115 See [input examples](https://platform.claude.com/docs/en/build-with-claude/working-with-messages).
115 See [input examples](https://platform.claude.com/docs/en/build-with-claude/working-with-messages?sdk_languages=http).
116116
117 Note that if you want to include a [system prompt](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices#give-claude-a-role), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API.
117 Note that if you want to include a [system prompt](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=http#give-claude-a-role), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API.
118118
119119 There is a limit of 100,000 messages in a single request.
120120
from line 147
147147 - `5m`: 5 minutes
148148 - `1h`: 1 hour
149149
150 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.
150 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=http) for details.
151151
152152 - `"5m"`
153153
from line 1277
12771277
12781278 - `format: optional JSONOutputFormat or null`
12791279
1280 A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs)
1280 A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs?sdk_languages=http)
12811281
12821282 - `type: "json_schema"`
12831283
from line 1289
12891289
12901290 Determines whether to use priority capacity (if available) or standard capacity for this request.
12911291
1292 Anthropic offers different levels of service for your API requests. See [service-tiers](https://platform.claude.com/docs/en/api/service-tiers) for details.
1292 Anthropic offers different levels of service for your API requests. See [service-tiers](https://platform.claude.com/docs/en/api/service-tiers?sdk_languages=http) for details.
12931293
12941294 - `"auto"`
12951295
from line 1307
13071307
13081308 Whether to incrementally stream the response using server-sent events. When `true`, SDKs return a raw event stream.
13091309
1310 In the TypeScript, Python and Ruby SDKs, the recommended way to stream is `messages.stream()`. It sets `stream` for you and accumulates the events into the final message. See [Streaming with SDKs](https://platform.claude.com/docs/en/build-with-claude/streaming#streaming-with-sdks) for an example in each language.
1310 In the TypeScript, Python and Ruby SDKs, the recommended way to stream is `messages.stream()`. It sets `stream` for you and accumulates the events into the final message. See [Streaming with SDKs](https://platform.claude.com/docs/en/build-with-claude/streaming?sdk_languages=http#streaming-with-sdks) for an example in each language.
13111311
13121312 - `system: optional string or array of TextBlockParam`
13131313
13141314 System prompt.
13151315
1316 A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices#give-claude-a-role).
1316 A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=http#give-claude-a-role).
13171317
13181318 - `string`
13191319
from line 1337
13371337
13381338 With `{"type": "adaptive"}`, Claude decides when and how much to think. With `{"type": "enabled"}` (manual extended thinking), you set a `budget_tokens` of at least 1,024. Thinking tokens count toward your `max_tokens` limit.
13391339
1340 Which `type` values are accepted, and what happens when you omit `thinking`, depend on the model. See [thinking](https://platform.claude.com/docs/en/build-with-claude/thinking#configuring-thinking) for each model's behavior.
1340 Which `type` values are accepted, and what happens when you omit `thinking`, depend on the model. See [thinking](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=http#configuring-thinking) for each model's behavior.
13411341
13421342 - `ThinkingConfigEnabled object`
13431343
from line 1349
13491349
13501350 Must be ≥1024 and less than `max_tokens`.
13511351
1352 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.
1352 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=http) for details.
13531353
13541354 minimum: 1024
13551355
13561356 - `display: optional "summarized" or "omitted" or null`
13571357
1358 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking#controlling-thinking-display).
1358 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=http#controlling-thinking-display).
13591359
13601360 - `"summarized"`
13611361
from line 1375
13751375
13761376 - `display: optional "summarized" or "omitted" or null`
13771377
1378 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking#controlling-thinking-display).
1378 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=http#controlling-thinking-display).
13791379
13801380 - `"summarized"`
13811381
from line 1437
14371437
14381438 If you include `tools` in your API request, the model may return `tool_use` content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using `tool_result` content blocks.
14391439
1440 There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool)).
1440 There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools?sdk_languages=http), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool?sdk_languages=http)).
14411441
14421442 Each tool definition includes:
14431443
from line 1493
14931493
14941494 Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output.
14951495
1496 See our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview) for more details.
1496 See our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview?sdk_languages=http) for more details.
14971497
14981498 - `Tool object`
14991499
from line 3272
32723272
32733273This endpoint is idempotent and can be used to poll for Message Batch completion. To access the results of a Message Batch, make a request to the `results_url` field in the response.
32743274
3275Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing)
3275Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=http)
32763276
32773277### Path parameters
32783278
from line 3286
32863286
32873287 The version of the Claude API you want to use.
32883288
3289 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
3289 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
32903290
32913291- `"anthropic-workspace-id": optional string`
32923292
from line 3441
34413441
34423442List all Message Batches within a Workspace. Most recently created batches are returned first.
34433443
3444Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing)
3444Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=http)
34453445
34463446### Query parameters
34473447
from line 3467
34673467
34683468 The version of the Claude API you want to use.
34693469
3470 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
3470 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
34713471
34723472- `"anthropic-workspace-id": optional string`
34733473
from line 3643
36433643
36443644The number of canceled requests is specified in `request_counts`. To determine which requests were canceled, check the individual results within the batch. Note that cancellation may not result in any canceled requests if they were non-interruptible.
36453645
3646Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing)
3646Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=http)
36473647
36483648### Path parameters
36493649
from line 3657
36573657
36583658 The version of the Claude API you want to use.
36593659
3660 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
3660 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
36613661
36623662- `"anthropic-workspace-id": optional string`
36633663
from line 3815
38153815
38163816Message Batches can only be deleted once they've finished processing. If you'd like to delete an in-progress batch, you must first cancel it.
38173817
3818Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing)
3818Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=http)
38193819
38203820### Path parameters
38213821
from line 3829
38293829
38303830 The version of the Claude API you want to use.
38313831
3832 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
3832 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
38333833
38343834- `"anthropic-workspace-id": optional string`
38353835
from line 3879
38793879
38803880Each line in the file is a JSON object containing the result of a single request in the Message Batch. Results are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests.
38813881
3882Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing)
3882Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=http)
38833883
38843884### Path parameters
38853885
from line 3893
38933893
38943894 The version of the Claude API you want to use.
38953895
3896 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
3896 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
38973897
38983898- `"anthropic-workspace-id": optional string`
38993899
from line 4164
41644164
41654165 This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact.
41664166
4167 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.
4167 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=http) for details.
41684168
41694169 - `thinking: string`
41704170
from line 4182
41824182
41834183 Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation.
41844184
4185 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking#redacted-thinking-blocks) for details.
4185 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=http#redacted-thinking-blocks) for details.
41864186
41874187 - `ToolUseBlock object`
41884188
from line 4884
48844884
48854885 - `"reasoning_extraction"`
48864886
4887 The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking).
4887 The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=http).
48884888
48894889 - `"general_harms"`
48904890
from line 5677
56775677
56785678 This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact.
56795679
5680 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.
5680 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=http) for details.
56815681
56825682 - `thinking: string`
56835683
from line 5695
56955695
56965696 Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation.
56975697
5698 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking#redacted-thinking-blocks) for details.
5698 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=http#redacted-thinking-blocks) for details.
56995699
57005700 - `ToolUseBlock object`
57015701
from line 6397
63976397
63986398 - `"reasoning_extraction"`
63996399
6400 The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking).
6400 The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=http).
64016401
64026402 - `"general_harms"`
64036403
from line 6962
69626962
69636963 This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact.
69646964
6965 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.
6965 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=http) for details.
69666966
69676967 - `thinking: string`
69686968
from line 6980
69806980
69816981 Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation.
69826982
6983 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking#redacted-thinking-blocks) for details.
6983 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=http#redacted-thinking-blocks) for details.
69846984
69856985 - `ToolUseBlock object`
69866986
from line 7682
76827682
76837683 - `"reasoning_extraction"`
76847684
7685 The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking).
7685 The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=http).
76867686
76877687 - `"general_harms"`
76887688
from line 8199
81998199
82008200 This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact.
82018201
8202 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.
8202 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=http) for details.
82038203
82048204 - `thinking: string`
82058205
from line 8217
82178217
82188218 Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation.
82198219
8220 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking#redacted-thinking-blocks) for details.
8220 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=http#redacted-thinking-blocks) for details.
82218221
82228222 - `ToolUseBlock object`
82238223
from line 8645
86458645
86468646 - `start_line: number or null`
86478647
8648 - `total_lines: number or null`
8649
8650 - `TextEditorCodeExecutionCreateResultBlock object`
8651
8652 - `type: "text_editor_code_execution_create_result"`
8653
8654 default: text_editor_code_execution_create_result
8655
8656 - `is_file_update: boolean`
8657
8658 - `TextEditorCodeExecutionStrReplaceResultBlock object`
8659
8660 - `type: "text_editor_code_execution_str_replace_result"`
8661
8662 default: text_editor_code_execution_str_replace_result
8663
8664 - `lines: array of string or null`
8665
8666 - `new_lines: number or null`
8667
8668 - `new_start: number or null`
8669
8670 - `old_lines: number or null`
8671
8672 - `old_start: number or null`
8673
8674 - `tool_use_id: string`
8675
8676 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
8677
8678 - `ToolSearchToolR
8648 - `total_lines: num