> ## Documentation Index
> Fetch the complete documentation index at: https://docs.evolink.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# Claude - Messages API
> - Send a structured list of input messages with text and/or image content, and the model will generate the next message in the conversation.
- The Messages API can be used for either single queries or stateless multi-turn conversations.
**BaseURL**: The default BaseURL is `https://direct.evolink.ai`, which has better support for text models and long-lived connections. `https://api.evolink.ai` is the primary endpoint for multimodal services and serves as a fallback address for text models.
## OpenAPI
````yaml /en/api-manual/language-series/claude/claude-messages-api.json POST /v1/messages
openapi: 3.1.0
info:
title: Claude Messages API
description: >-
Send a structured list of input messages with text and/or image content, and
the model will generate the next message in the conversation. The Messages
API can be used for either single queries or stateless multi-turn
conversations.
license:
name: MIT
version: 1.0.0
servers:
- url: https://direct.evolink.ai
description: Production (recommended)
- url: https://api.evolink.ai
description: Alternative URL
security:
- bearerAuth: []
tags:
- name: Messages
description: Claude AI message generation and conversation APIs
paths:
/v1/messages:
post:
tags:
- Messages
summary: Create a Message
description: >-
- Send a structured list of input messages with text and/or image
content, and the model will generate the next message in the
conversation.
- The Messages API can be used for either single queries or stateless
multi-turn conversations.
operationId: createMessage
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMessageParams'
example:
model: claude-sonnet-4-5-20250929
max_tokens: 1024
messages:
- role: user
content: Hello, world
responses:
'200':
description: Message object
content:
application/json:
schema:
$ref: '#/components/schemas/Message'
example:
model: claude-haiku-4-5-20251001
id: msg_bdrk_017XLrAa77zWvfBGQ6ESvrxz
type: message
role: assistant
content:
- type: text
text: |-
# Hey there! 👋
How's it going? What can I help you with today?
stop_reason: end_turn
stop_sequence: null
usage:
input_tokens: 8
cache_creation_input_tokens: 0
cache_read_input_tokens: 0
output_tokens: 24
'400':
description: Invalid request
content:
application/json:
schema:
$ref: bec9f8df-4739-47b7-8cfb-a2396ad4345b
example:
error:
message: Invalid request
type: invalid_request_error
request_id:
type: error
'401':
description: Authentication error
content:
application/json:
schema:
$ref: bec9f8df-4739-47b7-8cfb-a2396ad4345b
example:
error:
message: Authentication error
type: authentication_error
request_id:
type: error
'402':
description: Billing error
content:
application/json:
schema:
$ref: bec9f8df-4739-47b7-8cfb-a2396ad4345b
example:
error:
message: Billing error
type: billing_error
request_id:
type: error
fallback_suggestion: https://evolink.ai/dashboard/billing
'403':
description: Permission error
content:
application/json:
schema:
$ref: bec9f8df-4739-47b7-8cfb-a2396ad4345b
example:
error:
message: Permission denied
type: permission_error
request_id:
type: error
'404':
description: Not found
content:
application/json:
schema:
$ref: bec9f8df-4739-47b7-8cfb-a2396ad4345b
example:
error:
message: Not found
type: not_found_error
request_id:
type: error
'429':
description: Rate limit error
content:
application/json:
schema:
$ref: bec9f8df-4739-47b7-8cfb-a2396ad4345b
example:
error:
message: Rate limited
type: rate_limit_error
request_id:
type: error
fallback_suggestion: retry after 60 seconds
'500':
description: Internal server error
content:
application/json:
schema:
$ref: bec9f8df-4739-47b7-8cfb-a2396ad4345b
example:
error:
message: Internal server error
type: api_error
request_id:
type: error
fallback_suggestion: try again later
'503':
description: Service overloaded
content:
application/json:
schema:
$ref: bec9f8df-4739-47b7-8cfb-a2396ad4345b
example:
error:
message: Overloaded
type: overloaded_error
request_id:
type: error
fallback_suggestion: retry after 30 seconds
'524':
description: Cloudflare gateway timeout error
content:
application/json:
schema:
$ref: bec9f8df-4739-47b7-8cfb-a2396ad4345b
example:
error:
message: Request timeout
type: timeout_error
request_id:
type: error
fallback_suggestion: >-
Please switch the BaseURL to https://direct.evolink.ai; this
endpoint is better for long-running tasks
components:
schemas:
CreateMessageParams:
type: object
required:
- model
- messages
- max_tokens
additionalProperties: false
properties:
model:
type: string
description: The model that will complete your prompt.
enum:
- claude-haiku-4-5-20251001
- claude-sonnet-4-5-20250929
- claude-opus-4-1-20250805
- claude-sonnet-4-20250514
- claude-opus-4-5-20251101
- claude-opus-4-6
- claude-opus-4-7
- claude-sonnet-4-6
examples:
- claude-sonnet-4-5-20250929
title: Model
messages:
type: array
description: >-
Input messages.
Our models are trained to operate on alternating `user` and
`assistant` conversational turns. When creating a new `Message`, you
specify the prior conversational turns with the `messages`
parameter, and the model then generates the next `Message` in the
conversation. Consecutive `user` or `assistant` turns in your
request will be combined into a single turn.
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.
items:
$ref: '#/components/schemas/InputMessage'
title: Messages
max_tokens:
type: integer
description: >-
The maximum number of tokens to generate before stopping.
Note that our models may stop _before_ reaching this maximum. This
parameter only specifies the absolute maximum number of tokens to
generate.
examples:
- 1024
minimum: 1
title: Max Tokens
inference_geo:
type: string
description: >-
Specifies the geographic region for inference processing. If not
specified, the workspace's `default_inference_geo` is used.
title: Inference Geo
container:
description: Container identifier for reuse across requests.
title: Container
anyOf:
- $ref: '#/components/schemas/ContainerParams'
- type: string
- type: 'null'
context_management:
description: Context management configuration.
anyOf:
- $ref: '#/components/schemas/ContextManagementConfig'
- type: 'null'
mcp_servers:
type: array
description: MCP servers to be utilized in this request
items:
$ref: '#/components/schemas/RequestMCPServerURLDefinition'
maxItems: 20
title: Mcp Servers
metadata:
$ref: '#/components/schemas/Metadata'
description: An object describing metadata about the request.
output_config:
$ref: '#/components/schemas/OutputConfig'
description: >-
Configuration options for the model's output, such as the output
format.
service_tier:
type: string
description: >-
Determines whether to use priority capacity (if available) or
standard capacity for this request.
enum:
- auto
- standard_only
title: Service Tier
stop_sequences:
type: array
description: Custom text sequences that will cause the model to stop generating.
items:
type: string
title: Stop Sequences
stream:
type: boolean
description: >-
Whether to incrementally stream the response using server-sent
events.
title: Stream
system:
description: System prompt.
examples:
- Today's date is 2024-06-01.
title: System
anyOf:
- type: string
- type: array
items:
$ref: '#/components/schemas/RequestTextBlock'
temperature:
type: number
description: |-
Amount of randomness injected into the response.
Defaults to `1.0`. Ranges from `0.0` to `1.0`.
examples:
- 1
minimum: 0
maximum: 1
title: Temperature
thinking:
description: >-
Configuration for enabling Claude's extended thinking.
`type: "enabled"` requires `budget_tokens`, with a minimum of 1,024,
and counts against `max_tokens`. You can use `display` to control
how thinking content appears.
`type: "adaptive"` lets Claude decide when and how much extended
thinking to use based on request complexity; you can also use
`display` to control how thinking content appears.
`type: "disabled"` turns off extended thinking.
anyOf:
- $ref: '#/components/schemas/ThinkingConfigEnabled'
- $ref: '#/components/schemas/ThinkingConfigAdaptive'
- $ref: '#/components/schemas/ThinkingConfigDisabled'
tool_choice:
description: How the model should use the provided tools.
anyOf:
- $ref: '#/components/schemas/ToolChoiceAuto'
- $ref: '#/components/schemas/ToolChoiceAny'
- $ref: '#/components/schemas/ToolChoiceTool'
- $ref: '#/components/schemas/ToolChoiceNone'
tools:
type: array
description: Definitions of tools that the model may use.
items:
anyOf:
- $ref: '#/components/schemas/Tool'
- $ref: '#/components/schemas/BashTool_20241022'
- $ref: '#/components/schemas/BashTool_20250124'
- $ref: '#/components/schemas/CodeExecutionTool_20250522'
- $ref: '#/components/schemas/CodeExecutionTool_20250825'
- $ref: '#/components/schemas/ComputerUseTool_20241022'
- $ref: '#/components/schemas/MemoryTool_20250818'
- $ref: '#/components/schemas/ComputerUseTool_20250124'
- $ref: '#/components/schemas/TextEditor_20241022'
- $ref: '#/components/schemas/TextEditor_20250124'
- $ref: '#/components/schemas/TextEditor_20250429'
- $ref: '#/components/schemas/TextEditor_20250728'
- $ref: '#/components/schemas/WebSearchTool_20250305'
- $ref: '#/components/schemas/WebFetchTool_20250910'
title: Tools
top_k:
type: integer
description: Only sample from the top K options for each subsequent token.
examples:
- 5
minimum: 0
title: Top K
top_p:
type: number
description: Use nucleus sampling.
examples:
- 0.7
minimum: 0
maximum: 1
title: Top P
Message:
type: object
required:
- id
- type
- role
- content
- model
- stop_reason
- stop_sequence
- usage
properties:
id:
type: string
description: |-
Unique object identifier.
The format and length of IDs may change over time.
examples:
- msg_013Zva2CMHLNnXjNJJKqJ2EF
title: Id
type:
type: string
const: message
description: |-
Object type.
For Messages, this is always `"message"`.
title: Type
role:
type: string
const: assistant
description: |-
Conversational role of the generated message.
This will always be `"assistant"`.
title: Role
content:
type: array
description: >-
Content generated by the model.
This is an array of content blocks, each of which has a `type` that
determines its shape.
items:
anyOf:
- $ref: '#/components/schemas/ResponseTextBlock'
- $ref: '#/components/schemas/ResponseThinkingBlock'
- $ref: '#/components/schemas/ResponseRedactedThinkingBlock'
- $ref: '#/components/schemas/ResponseToolUseBlock'
- $ref: '#/components/schemas/ResponseServerToolUseBlock'
- $ref: '#/components/schemas/ResponseWebSearchToolResultBlock'
- $ref: '#/components/schemas/ResponseWebFetchToolResultBlock'
- $ref: '#/components/schemas/ResponseCodeExecutionToolResultBlock'
- $ref: '#/components/schemas/ResponseBashCodeExecutionToolResultBlock'
- $ref: >-
#/components/schemas/ResponseTextEditorCodeExecutionToolResultBlock
- $ref: '#/components/schemas/ResponseMCPToolUseBlock'
- $ref: '#/components/schemas/ResponseMCPToolResultBlock'
- $ref: '#/components/schemas/ResponseContainerUploadBlock'
title: Content
model:
type: string
description: The model that handled the request.
enum:
- claude-haiku-4-5-20251001
- claude-sonnet-4-5-20250929
- claude-opus-4-1-20250805
- claude-sonnet-4-20250514
- claude-opus-4-5-20251101
- claude-opus-4-6
- claude-opus-4-7
- claude-sonnet-4-6
examples:
- claude-sonnet-4-5-20250929
title: Model
stop_reason:
type: string
nullable: true
description: The reason that we stopped.
enum:
- end_turn
- max_tokens
- stop_sequence
- tool_use
- pause_turn
- refusal
- model_context_window_exceeded
title: Stop Reason
stop_sequence:
type: string
nullable: true
description: Which custom stop sequence was generated, if any.
title: Stop Sequence
usage:
$ref: '#/components/schemas/Usage'
description: Billing and rate-limit usage.
context_management:
anyOf:
- $ref: '#/components/schemas/ResponseContextManagement'
- type: 'null'
description: Context management response.
container:
anyOf:
- $ref: '#/components/schemas/Container'
- type: 'null'
description: Information about the container used in this request.
InputMessage:
additionalProperties: false
properties:
content:
anyOf:
- type: string
- items:
discriminator:
mapping:
bash_code_execution_tool_result:
$ref: >-
#/components/schemas/RequestBashCodeExecutionToolResultBlock
code_execution_tool_result:
$ref: '#/components/schemas/RequestCodeExecutionToolResultBlock'
container_upload:
$ref: '#/components/schemas/RequestContainerUploadBlock'
document:
$ref: '#/components/schemas/RequestDocumentBlock'
image:
$ref: '#/components/schemas/RequestImageBlock'
mcp_tool_result:
$ref: '#/components/schemas/RequestMCPToolResultBlock'
mcp_tool_use:
$ref: '#/components/schemas/RequestMCPToolUseBlock'
redacted_thinking:
$ref: '#/components/schemas/RequestRedactedThinkingBlock'
search_result:
$ref: '#/components/schemas/RequestSearchResultBlock'
server_tool_use:
$ref: '#/components/schemas/RequestServerToolUseBlock'
text:
$ref: '#/components/schemas/RequestTextBlock'
text_editor_code_execution_tool_result:
$ref: >-
#/components/schemas/RequestTextEditorCodeExecutionToolResultBlock
thinking:
$ref: '#/components/schemas/RequestThinkingBlock'
tool_result:
$ref: '#/components/schemas/RequestToolResultBlock'
tool_use:
$ref: '#/components/schemas/RequestToolUseBlock'
web_fetch_tool_result:
$ref: '#/components/schemas/RequestWebFetchToolResultBlock'
web_search_tool_result:
$ref: '#/components/schemas/RequestWebSearchToolResultBlock'
propertyName: type
oneOf:
- $ref: '#/components/schemas/RequestTextBlock'
description: Regular text content.
- $ref: '#/components/schemas/RequestImageBlock'
description: >-
Image content specified directly as base64 data or as a
reference via a URL.
- $ref: '#/components/schemas/RequestDocumentBlock'
description: >-
Document content, either specified directly as base64
data, as text, or as a reference via a URL.
- $ref: '#/components/schemas/RequestSearchResultBlock'
description: >-
A search result block containing source, title, and
content from search operations.
- $ref: '#/components/schemas/RequestThinkingBlock'
description: A block specifying internal thinking by the model.
- $ref: '#/components/schemas/RequestRedactedThinkingBlock'
description: >-
A block specifying internal, redacted thinking by the
model.
- $ref: '#/components/schemas/RequestToolUseBlock'
description: A block indicating a tool use by the model.
- $ref: '#/components/schemas/RequestToolResultBlock'
description: A block specifying the results of a tool use by the model.
- $ref: '#/components/schemas/RequestServerToolUseBlock'
- $ref: '#/components/schemas/RequestWebSearchToolResultBlock'
- $ref: '#/components/schemas/RequestWebFetchToolResultBlock'
- $ref: '#/components/schemas/RequestCodeExecutionToolResultBlock'
- $ref: >-
#/components/schemas/RequestBashCodeExecutionToolResultBlock
- $ref: >-
#/components/schemas/RequestTextEditorCodeExecutionToolResultBlock
- $ref: '#/components/schemas/RequestMCPToolUseBlock'
- $ref: '#/components/schemas/RequestMCPToolResultBlock'
- $ref: '#/components/schemas/RequestContainerUploadBlock'
type: array
title: Content
role:
enum:
- user
- assistant
title: Role
type: string
required:
- content
- role
title: InputMessage
type: object
ContainerParams:
additionalProperties: false
description: Container parameters with skills to be loaded.
properties:
id:
anyOf:
- type: string
- type: 'null'
description: Container id
title: Id
skills:
anyOf:
- items:
$ref: '#/components/schemas/SkillParams'
maxItems: 8
type: array
- type: 'null'
description: List of skills to load in the container
title: Skills
title: ContainerParams
type: object
ContextManagementConfig:
additionalProperties: false
properties:
edits:
description: List of context management edits to apply
items:
discriminator:
mapping:
clear_thinking_20251015:
$ref: '#/components/schemas/ClearThinking20251015'
clear_tool_uses_20250919:
$ref: '#/components/schemas/ClearToolUses20250919'
propertyName: type
oneOf:
- $ref: '#/components/schemas/ClearToolUses20250919'
- $ref: '#/components/schemas/ClearThinking20251015'
minItems: 0
title: Edits
type: array
title: ContextManagementConfig
type: object
RequestMCPServerURLDefinition:
additionalProperties: false
properties:
authorization_token:
anyOf:
- type: string
- type: 'null'
title: Authorization Token
name:
title: Name
type: string
tool_configuration:
anyOf:
- $ref: '#/components/schemas/RequestMCPServerToolConfiguration'
- type: 'null'
type:
const: url
title: Type
type: string
url:
title: Url
type: string
required:
- name
- type
- url
title: RequestMCPServerURLDefinition
type: object
Metadata:
additionalProperties: false
properties:
user_id:
anyOf:
- maxLength: 256
type: string
- type: 'null'
description: >-
An external identifier for the user who is associated with the
request.
This should be a uuid, hash value, or other opaque identifier.
Anthropic may use this id to help detect abuse. Do not include any
identifying information such as name, email address, or phone
number.
examples:
- 13803d75-b4b5-4c3e-b2a2-6f21399b021b
title: User Id
title: Metadata
type: object
OutputConfig:
additionalProperties: false
properties:
effort:
description: Output effort level.
enum:
- low
- medium
- high
- xhigh
- max
title: Effort
type: string
format:
$ref: '#/components/schemas/JSONOutputFormat'
description: Schema used to constrain Claude output format.
task_budget:
$ref: '#/components/schemas/TokenTaskBudget'
description: Total token budget across contexts.
title: OutputConfig
type: object
RequestTextBlock:
additionalProperties: false
properties:
cache_control:
anyOf:
- discriminator:
mapping:
ephemeral:
$ref: '#/components/schemas/CacheControlEphemeral'
propertyName: type
oneOf:
- $ref: '#/components/schemas/CacheControlEphemeral'
- type: 'null'
description: Create a cache control breakpoint at this content block.
title: Cache Control
citations:
anyOf:
- items:
discriminator:
mapping:
char_location:
$ref: '#/components/schemas/RequestCharLocationCitation'
content_block_location:
$ref: '#/components/schemas/RequestContentBlockLocationCitation'
page_location:
$ref: '#/components/schemas/RequestPageLocationCitation'
search_result_location:
$ref: '#/components/schemas/RequestSearchResultLocationCitation'
web_search_result_location:
$ref: >-
#/components/schemas/RequestWebSearchResultLocationCitation
propertyName: type
oneOf:
- $ref: '#/components/schemas/RequestCharLocationCitation'
- $ref: '#/components/schemas/RequestPageLocationCitation'
- $ref: '#/components/schemas/RequestContentBlockLocationCitation'
- $ref: >-
#/components/schemas/RequestWebSearchResultLocationCitation
- $ref: '#/components/schemas/RequestSearchResultLocationCitation'
type: array
- type: 'null'
title: Citations
text:
minLength: 1
title: Text
type: string
type:
const: text
title: Type
type: string
required:
- text
- type
title: Text
type: object
ThinkingConfigEnabled:
additionalProperties: false
properties:
budget_tokens:
description: >-
Determines how many tokens Claude can use for its internal reasoning
process. Larger budgets can enable more thorough analysis for
complex problems, improving response quality.
Must be ≥1024 and less than `max_tokens`.
See [extended
thinking](https://docs.claude.com/en/docs/build-with-claude/extended-thinking)
for details.
minimum: 1024
title: Budget Tokens
type: integer
display:
description: Controls how thinking content appears in the response.
enum:
- summarized
- omitted
title: Display
type: string
type:
const: enabled
title: Type
type: string
required:
- budget_tokens
- type
title: Enabled
type: object
ThinkingConfigAdaptive:
additionalProperties: false
properties:
display:
description: Controls how thinking content appears in the response.
enum:
- summarized
- omitted
title: Display
type: string
type:
const: adaptive
title: Type
type: string
required:
- type
title: Adaptive
type: object
ThinkingConfigDisabled:
additionalProperties: false
properties:
type:
const: disabled
title: Type
type: string
required:
- type
title: Disabled
type: object
ToolChoiceAuto:
additionalProperties: false
description: The model will automatically decide whether to use tools.
properties:
disable_parallel_tool_use:
description: >-
Whether to disable parallel tool use.
Defaults to `false`. If set to `true`, the model will output at most
one tool use.
title: Disable Parallel Tool Use
type: boolean
type:
const: auto
title: Type
type: string
required:
- type
title: Auto
type: object
ToolChoiceAny:
additionalProperties: false
description: The model will use any available tools.
properties:
disable_parallel_tool_use:
description: >-
Whether to disable parallel tool use.
Defaults to `false`. If set to `true`, the model will output exactly
one tool use.
title: Disable Parallel Tool Use
type: boolean
type:
const: any
title: Type
type: string
required:
- type
title: Any
type: object
ToolChoiceTool:
additionalProperties: false
description: The model will use the specified tool with `tool_choice.name`.
properties:
disable_parallel_tool_use:
description: >-
Whether to disable parallel tool use.
Defaults to `false`. If set to `true`, the model will output exactly
one tool use.
title: Disable Parallel Tool Use
type: boolean
name:
description: The name of the tool to use.
title: Name
type: string
type:
const: tool
title: Type
type: string
required:
- name
- type
title: Tool
type: object
ToolChoiceNone:
additionalProperties: false
description: The model will not be allowed to use tools.
properties:
type:
const: none
title: Type
type: string
required:
- type
title: None
type: object
Tool:
additionalProperties: false
properties:
type:
anyOf:
- type: 'null'
- const: custom
type: string
title: Type
description:
description: >-
Description of what this tool does.
Tool descriptions should be as detailed as possible. The more
information that the model has about what the tool is and how to use
it, the better it will perform. You can use natural language
descriptions to reinforce important aspects of the tool input JSON
schema.
examples:
- Get the current weather in a given location
title: Description
type: string
name:
description: >-
Name of the tool.
This is how the tool will be called by the model and in `tool_use`
blocks.
maxLength: 128
minLength: 1
pattern: ^[a-zA-Z0-9_-]{1,128}$
title: Name
type: string
input_schema:
$ref: '#/components/schemas/InputSchema'
description: >-
[JSON schema](https://json-schema.org/draft/2020-12) for this tool's
input.
This defines the shape of the `input` that your tool accepts and
that the model will produce.
examples:
- properties:
location:
description: The city and state, e.g. San Francisco, CA
type: string
unit:
description: Unit for the output - one of (celsius, fahrenheit)
type: string
required:
- location
type: object
cache_control:
anyOf:
- discriminator:
mapping:
ephemeral:
$ref: '#/components/schemas/CacheControlEphemeral'
propertyName: type
oneOf:
- $ref: '#/components/schemas/CacheControlEphemeral'
- type: 'null'
description: Create a cache control breakpoint at this content block.
title: Cache Control
required:
- name
- input_schema
title: Custom tool
type: object
BashTool_20241022:
additionalProperties: false
properties:
cache_control:
anyOf:
- discriminator:
mapping:
ephemeral:
$ref: '#/components/schemas/CacheControlEphemeral'
propertyName: type
oneOf:
- $ref: '#/components/schemas/CacheControlEphemeral'
- type: 'null'
description: Create a cache control breakpoint at this content block.
title: Cache Control
name:
const: bash
description: >-
Name of the tool.
This is how the tool will be called by the model and in `tool_use`
blocks.
title: Name
type: string
type:
const: bash_20241022
title: Type
type: string
required:
- name
- type
title: Bash tool (2024-10-22)
type: object
BashTool_20250124:
additionalProperties: false
properties:
cache_control:
anyOf:
- discriminator:
mapping:
ephemeral:
$ref: '#/components/schemas/CacheControlEphemeral'
propertyName: type
oneOf:
- $ref: '#/components/schemas/CacheControlEphemeral'
- type: 'null'
description: Create a cache control breakpoint at this content block.
title: Cache Control
name:
const: bash
description: >-
Name of the tool.
This is how the tool will be called by the model and in `tool_use`
blocks.
title: Name
type: string
type:
const: bash_20250124
title: Type
type: string
required:
- name
- type
title: Bash tool (2025-01-24)
type: object
CodeExecutionTool_20250522:
additionalProperties: false
properties:
cache_control:
anyOf:
- discriminator:
mapping:
ephemeral:
$ref: '#/components/schemas/CacheControlEphemeral'
propertyName: type
oneOf:
- $ref: '#/components/schemas/CacheControlEphemeral'
- type: 'null'
description: Create a cache control breakpoint at this content block.
title: Cache Control
name:
const: code_execution
description: >-
Name of the tool.
This is how the tool will be called by the model and in `tool_use`
blocks.
title: Name
type: string
type:
const: code_execution_20250522
title: Type
type: string
required:
- name
- type
title: Code execution tool (2025-05-22)
type: object
CodeExecutionTool_20250825:
additionalProperties: false
properties:
cache_control:
anyOf:
- discriminator:
mapping:
ephemeral:
$ref: '#/components/schemas/CacheControlEphemeral'
propertyName: type
oneOf:
- $ref: '#/components/schemas/CacheControlEphemeral'
- type: 'null'
description: Create a cache control breakpoint at this content block.
title: Cache Control
name:
const: code_execution
description: >-
Name of the tool.
This is how the tool will be called by the model and in `tool_use`
blocks.
title: Name
type: string
type:
const: code_execution_20250825
title: Type
type: string
required:
- name
- type
title: CodeExecutionTool_20250825
type: object
ComputerUseTool_20241022:
additionalProperties: false
properties:
cache_control:
anyOf:
- discriminator:
mapping:
ephemeral:
$ref: '#/components/schemas/CacheControlEphemeral'
propertyName: type
oneOf:
- $ref: '#/components/schemas/CacheControlEphemeral'
- type: 'null'
description: Create a cache control breakpoint at this content block.
title: Cache Control
display_height_px:
description: The height of the display in pixels.
minimum: 1
title: Display Height Px
type: integer
display_number:
anyOf:
- minimum: 0
type: integer
- type: 'null'
description: The X11 display number (e.g. 0, 1) for the display.
title: Display Number
display_width_px:
description: The width of the display in pixels.
minimum: 1
title: Display Width Px
type: integer
name:
const: computer
description: >-
Name of the tool.
This is how the tool will be called by the model and in `tool_use`
blocks.
title: Name
type: string
type:
const: computer_20241022
title: Type
type: string
required:
- display_height_px
- display_width_px
- name
- type
title: Computer use tool (2024-01-22)
type: object
MemoryTool_20250818:
additionalProperties: false
properties:
cache_control:
anyOf:
- discriminator:
mapping:
ephemeral:
$ref: '#/components/schemas/CacheControlEphemeral'
propertyName: type
oneOf:
- $ref: '#/components/schemas/CacheControlEphemeral'
- type: 'null'
description: Create a cache control breakpoint at this content block.
title: Cache Control
name:
const: memory
description: >-
Name of the tool.
This is how the tool will be called by the model and in `tool_use`
blocks.
title: Name
type: string
type:
const: memory_20250818
title: Type
type: string
required:
- name
- type
title: MemoryTool_20250818
type: object
ComputerUseTool_20250124:
additionalProperties: false
properties:
cache_control:
anyOf:
- discriminator:
mapping:
ephemeral:
$ref: '#/components/schemas/CacheControlEphemeral'
propertyName: type
oneOf:
- $ref: '#/components/schemas/CacheControlEphemeral'
- type: 'null'
description: Create a cache control breakpoint at this content block.
title: Cache Control
display_height_px:
description: The height of the display in pixels.
minimum: 1
title: Display Height Px
type: integer
display_number:
anyOf:
- minimum: 0
type: integer
- type: 'null'
description: The X11 display number (e.g. 0, 1) for the display.
title: Display Number
display_width_px:
description: The width of the display in pixels.
minimum: 1
title: Display Width Px
type: integer
name:
const: computer
description: >-
Name of the tool.
This is how the tool will be called by the model and in `tool_use`
blocks.
title: Name
type: string
type:
const: computer_20250124
title: Type
type: string
required:
- display_height_px
- display_width_px
- name
- type
title: Computer use tool (2025-01-24)
type: object
TextEditor_20241022:
additionalProperties: false
properties:
cache_control:
anyOf:
- discriminator:
mapping:
ephemeral:
$ref: '#/components/schemas/CacheControlEphemeral'
propertyName: type
oneOf:
- $ref: '#/components/schemas/CacheControlEphemeral'
- type: 'null'
description: Create a cache control breakpoint at this content block.
title: Cache Control
name:
const: str_replace_editor
description: >-
Name of the tool.
This is how the tool will be called by the model and in `tool_use`
blocks.
title: Name
type: string
type:
const: text_editor_20241022
title: Type
type: string
required:
- name
- type
title: Text editor tool (2024-10-22)
type: object
TextEditor_20250124:
additionalProperties: false
properties:
cache_control:
anyOf:
- discriminator:
mapping:
ephemeral:
$ref: '#/components/schemas/CacheControlEphemeral'
propertyName: type
oneOf:
- $ref: '#/components/schemas/CacheControlEphemeral'
- type: 'null'
description: Create a cache control breakpoint at this content block.
title: Cache Control
name:
const: str_replace_editor
description: >-
Name of the tool.
This is how the tool will be called by the model and in `tool_use`
blocks.
title: Name
type: string
type:
const: text_editor_20250124
title: Type
type: string
required:
- name
- type
title: Text editor tool (2025-01-24)
type: object
TextEditor_20250429:
additionalProperties: false
properties:
cache_control:
anyOf:
- discriminator:
mapping:
ephemeral:
$ref: '#/components/schemas/CacheControlEphemeral'
propertyName: type
oneOf:
- $ref: '#/components/schemas/CacheControlEphemeral'
- type: 'null'
description: Create a cache control breakpoint at this content block.
title: Cache Control
name:
const: str_replace_based_edit_tool
description: >-
Name of the tool.
This is how the tool will be called by the model and in `tool_use`
blocks.
title: Name
type: string
type:
const: text_editor_20250429
title: Type
type: string
required:
- name
- type
title: Text editor tool (2025-04-29)
type: object
TextEditor_20250728:
additionalProperties: false
properties:
cache_control:
anyOf:
- discriminator:
mapping:
ephemeral:
$ref: '#/components/schemas/CacheControlEphemeral'
propertyName: type
oneOf:
- $ref: '#/components/schemas/CacheControlEphemeral'
- type: 'null'
description: Create a cache control breakpoint at this content block.
title: Cache Control
max_characters:
anyOf:
- minimum: 1
type: integer
- type: 'null'
description: >-
Maximum number of characters to display when viewing a file. If not
specified, defaults to displaying the full file.
title: Max Characters
name:
const: str_replace_based_edit_tool
description: >-
Name of the tool.
This is how the tool will be called by the model and in `tool_use`
blocks.
title: Name
type: string
type:
const: text_editor_20250728
title: Type
type: string
required:
- name
- type
title: TextEditor_20250728
type: object
WebSearchTool_20250305:
additionalProperties: false
properties:
allowed_domains:
anyOf:
- items:
type: string
type: array
- type: 'null'
description: >-
If provided, only these domains will be included in results. Cannot
be used alongside `blocked_domains`.
title: Allowed Domains
blocked_domains:
anyOf:
- items:
type: string
type: array
- type: 'null'
description: >-
If provided, these domains will never appear in results. Cannot be
used alongside `allowed_domains`.
title: Blocked Domains
cache_control:
anyOf:
- discriminator:
mapping:
ephemeral:
$ref: '#/components/schemas/CacheControlEphemeral'
propertyName: type
oneOf:
- $ref: '#/components/schemas/CacheControlEphemeral'
- type: 'null'
description: Create a cache control breakpoint at this content block.
title: Cache Control
max_uses:
anyOf:
- exclusiveMinimum: 0
type: integer
- type: 'null'
description: Maximum number of times the tool can be used in the API request.
title: Max Uses
name:
const: web_search
description: >-
Name of the tool.
This is how the tool will be called by the model and in `tool_use`
blocks.
title: Name
type: string
type:
const: web_search_20250305
title: Type
type: string
user_location:
anyOf:
- $ref: '#/components/schemas/UserLocation'
- type: 'null'
description: >-
Parameters for the user's location. Used to provide more relevant
search results.
required:
- name
- type
title: Web search tool (2025-03-05)
type: object
WebFetchTool_20250910:
additionalProperties: false
properties:
allowed_domains:
anyOf:
- items:
type: string
type: array
- type: 'null'
description: List of domains to allow fetching from
title: Allowed Domains
blocked_domains:
anyOf:
- items:
type: string
type: array
- type: 'null'
description: List of domains to block fetching from
title: Blocked Domains
cache_control:
anyOf:
- discriminator:
mapping:
ephemeral:
$ref: '#/components/schemas/CacheControlEphemeral'
propertyName: type
oneOf:
- $ref: '#/components/schemas/CacheControlEphemeral'
- type: 'null'
description: Create a cache control breakpoint at this content block.
title: Cache Control
citations:
anyOf:
- $ref: '#/components/schemas/RequestCitationsConfig'
- type: 'null'
description: >-
Citations configuration for fetched documents. Citations are
disabled by default.
max_content_tokens:
anyOf:
- exclusiveMinimum: 0
type: integer
- type: 'null'
description: >-
Maximum number of tokens used by including web page text content in
the context. The limit is approximate and does not apply to binary
content such as PDFs.
title: Max Content Tokens
max_uses:
anyOf:
- exclusiveMinimum: 0
type: integer
- type: 'null'
description: Maximum number of times the tool can be used in the API request.
title: Max Uses
name:
const: web_fetch
description: >-
Name of the tool.
This is how the tool will be called by the model and in `tool_use`
blocks.
title: Name
type: string
type:
const: web_fetch_20250910
title: Type
type: string
required:
- name
- type
title: WebFetchTool_20250910
type: object
ResponseTextBlock:
properties:
citations:
anyOf:
- items:
discriminator:
mapping:
char_location:
$ref: '#/components/schemas/ResponseCharLocationCitation'
content_block_location:
$ref: >-
#/components/schemas/ResponseContentBlockLocationCitation
page_location:
$ref: '#/components/schemas/ResponsePageLocationCitation'
search_result_location:
$ref: >-
#/components/schemas/ResponseSearchResultLocationCitation
web_search_result_location:
$ref: >-
#/components/schemas/ResponseWebSearchResultLocationCitation
propertyName: type
oneOf:
- $ref: '#/components/schemas/ResponseCharLocationCitation'
- $ref: '#/components/schemas/ResponsePageLocationCitation'
- $ref: '#/components/schemas/ResponseContentBlockLocationCitation'
- $ref: >-
#/components/schemas/ResponseWebSearchResultLocationCitation
- $ref: '#/components/schemas/ResponseSearchResultLocationCitation'
type: array
- type: 'null'
default: null
description: >-
Citations supporting the text block.
The type of citation returned will depend on the type of document
being cited. Citing a PDF results in `page_location`, plain text
results in `char_location`, and content document results in
`content_block_location`.
title: Citations
text:
maxLength: 5000000
minLength: 0
title: Text
type: string
type:
const: text
default: text
title: Type
type: string
required:
- citations
- text
- type
title: Text
type: object
ResponseThinkingBlock:
properties:
signature:
title: Signature
type: string
thinking:
title: Thinking
type: string
type:
const: thinking
default: thinking
title: Type
type: string
required:
- signature
- thinking
- type
title: Thinking
type: object
ResponseRedactedThinkingBlock:
properties:
data:
title: Data
type: string
type:
const: redacted_thinking
default: redacted_thinking
title: Type
type: string
required:
- data
- type
title: Redacted thinking
type: object
ResponseToolUseBlock:
properties:
id:
pattern: ^[a-zA-Z0-9_-]+$
title: Id
type: string
input:
additionalProperties: true
title: Input
type: object
name:
minLength: 1
title: Name
type: string
type:
const: tool_use
default: tool_use
title: Type
type: string
required:
- id
- input
- name
- type
title: Tool use
type: object
ResponseServerToolUseBlock:
properties:
id:
pattern: ^srvtoolu_[a-zA-Z0-9_]+$
title: Id
type: string
input:
additionalProperties: true
title: Input
type: object
name:
enum:
- web_search
- web_fetch
- code_execution
- bash_code_execution
- text_editor_code_execution
title: Name
type: string
type:
const: server_tool_use
default: server_tool_use
title: Type
type: string
required:
- id
- input
- name
- type
title: Server tool use
type: object
ResponseWebSearchToolResultBlock:
properties:
content:
anyOf:
- $ref: '#/components/schemas/ResponseWebSearchToolResultError'
- items:
$ref: '#/components/schemas/ResponseWebSearchResultBlock'
type: array
title: Content
tool_use_id:
pattern: ^srvtoolu_[a-zA-Z0-9_]+$
title: Tool Use Id
type: string
type:
const: web_search_tool_result
default: web_search_tool_result
title: Type
type: string
required:
- content
- tool_use_id
- type
title: Web search tool result
type: object
ResponseWebFetchToolResultBlock:
properties:
content:
anyOf:
- $ref: '#/components/schemas/ResponseWebFetchToolResultError'
- $ref: '#/components/schemas/ResponseWebFetchResultBlock'
title: Content
tool_use_id:
pattern: ^srvtoolu_[a-zA-Z0-9_]+$
title: Tool Use Id
type: string
type:
const: web_fetch_tool_result
default: web_fetch_tool_result
title: Type
type: string
required:
- content
- tool_use_id
- type
title: ResponseWebFetchToolResultBlock
type: object
ResponseCodeExecutionToolResultBlock:
properties:
content:
anyOf:
- $ref: '#/components/schemas/ResponseCodeExecutionToolResultError'
- $ref: '#/components/schemas/ResponseCodeExecutionResultBlock'
title: Content
tool_use_id:
pattern: ^srvtoolu_[a-zA-Z0-9_]+$
title: Tool Use Id
type: string
type:
const: code_execution_tool_result
default: code_execution_tool_result
title: Type
type: string
required:
- content
- tool_use_id
- type
title: Code execution tool result
type: object
ResponseBashCodeExecutionToolResultBlock:
properties:
content:
anyOf:
- $ref: '#/components/schemas/ResponseBashCodeExecutionToolResultError'
- $ref: '#/components/schemas/ResponseBashCodeExecutionResultBlock'
title: Content
tool_use_id:
pattern: ^srvtoolu_[a-zA-Z0-9_]+$
title: Tool Use Id
type: string
type:
const: bash_code_execution_tool_result
default: bash_code_execution_tool_result
title: Type
type: string
required:
- content
- tool_use_id
- type
title: ResponseBashCodeExecutionToolResultBlock
type: object
ResponseTextEditorCodeExecutionToolResultBlock:
properties:
content:
anyOf:
- $ref: >-
#/components/schemas/ResponseTextEditorCodeExecutionToolResultError
- $ref: >-
#/components/schemas/ResponseTextEditorCodeExecutionViewResultBlock
- $ref: >-
#/components/schemas/ResponseTextEditorCodeExecutionCreateResultBlock
- $ref: >-
#/components/schemas/ResponseTextEditorCodeExecutionStrReplaceResultBlock
title: Content
tool_use_id:
pattern: ^srvtoolu_[a-zA-Z0-9_]+$
title: Tool Use Id
type: string
type:
const: text_editor_code_execution_tool_result
default: text_editor_code_execution_tool_result
title: Type
type: string
required:
- content
- tool_use_id
- type
title: ResponseTextEditorCodeExecutionToolResultBlock
type: object
ResponseMCPToolUseBlock:
properties:
id:
pattern: ^[a-zA-Z0-9_-]+$
title: Id
type: string
input:
additionalProperties: true
title: Input
type: object
name:
description: The name of the MCP tool
title: Name
type: string
server_name:
description: The name of the MCP server
title: Server Name
type: string
type:
const: mcp_tool_use
default: mcp_tool_use
title: Type
type: string
required:
- id
- input
- name
- server_name
- type
title: MCP tool use
type: object
ResponseMCPToolResultBlock:
properties:
content:
anyOf:
- type: string
- items:
$ref: '#/components/schemas/ResponseTextBlock'
type: array
title: Content
is_error:
default: false
title: Is Error
type: boolean
tool_use_id:
pattern: ^[a-zA-Z0-9_-]+$
title: Tool Use Id
type: string
type:
const: mcp_tool_result
default: mcp_tool_result
title: Type
type: string
required:
- content
- is_error
- tool_use_id
- type
title: MCP tool result
type: object
ResponseContainerUploadBlock:
description: Response model for a file uploaded to the container.
properties:
file_id:
title: File Id
type: string
type:
const: container_upload
default: container_upload
title: Type
type: string
required:
- file_id
- type
title: Container upload
type: object
Usage:
properties:
cache_creation:
anyOf:
- $ref: '#/components/schemas/CacheCreation'
- type: 'null'
default: null
description: Breakdown of cached tokens by TTL
cache_creation_input_tokens:
anyOf:
- minimum: 0
type: integer
- type: 'null'
default: null
description: The number of input tokens used to create the cache entry.
examples:
- 2051
title: Cache Creation Input Tokens
cache_read_input_tokens:
anyOf:
- minimum: 0
type: integer
- type: 'null'
default: null
description: The number of input tokens read from the cache.
examples:
- 2051
title: Cache Read Input Tokens
input_tokens:
description: The number of input tokens which were used.
examples:
- 2095
minimum: 0
title: Input Tokens
type: integer
output_tokens:
description: The number of output tokens which were used.
examples:
- 503
minimum: 0
title: Output Tokens
type: integer
server_tool_use:
anyOf:
- $ref: '#/components/schemas/ServerToolUsage'
- type: 'null'
default: null
description: The number of server tool requests.
service_tier:
anyOf:
- enum:
- standard
- priority
- batch
type: string
- type: 'null'
default: null
description: If the request used the priority, standard, or batch tier.
title: Service Tier
required:
- cache_creation
- cache_creation_input_tokens
- cache_read_input_tokens
- input_tokens
- output_tokens
- server_tool_use
- service_tier
title: Usage
type: object
ResponseContextManagement:
properties:
applied_edits:
description: List of context management edits that were applied.
items:
discriminator:
mapping:
clear_thinking_20251015:
$ref: '#/components/schemas/ResponseClearThinking20251015Edit'
clear_tool_uses_20250919:
$ref: '#/components/schemas/ResponseClearToolUses20250919Edit'
propertyName: type
oneOf:
- $ref: '#/components/schemas/ResponseClearToolUses20250919Edit'
- $ref: '#/components/schemas/ResponseClearThinking20251015Edit'
title: Applied Edits
type: array
required:
- applied_edits
title: ResponseContextManagement
type: object
Container:
description: >-
Information about the container used in the request (for the code
execution tool)
properties:
expires_at:
description: The time at which the container will expire.
format: date-time
title: Expires At
type: string
id:
description: Identifier for the container used in this request
title: Id
type: string
skills:
anyOf:
- items:
$ref: '#/components/schemas/Skill'
type: array
- type: 'null'
default: null
description: Skills loaded in the container
title: Skills
required:
- expires_at
- id
- skills
title: Container
type: object
RequestBashCodeExecutionToolResultBlock:
additionalProperties: false
properties:
cache_control:
anyOf:
- discriminator:
mapping:
ephemeral:
$ref: '#/components/schemas/CacheControlEphemeral'
propertyName: type
oneOf:
- $ref: '#/components/schemas/CacheControlEphemeral'
- type: 'null'
description: Create a cache control breakpoint at this content block.
title: Cache Control
content:
anyOf:
- $ref: '#/components/schemas/RequestBashCodeExecutionToolResultError'
- $ref: '#/components/schemas/RequestBashCodeExecutionResultBlock'
title: Content
tool_use_id:
pattern: ^srvtoolu_[a-zA-Z0-9_]+$
title: Tool Use Id
type: string
type:
const: bash_code_execution_tool_result
title: Type
type: string
required:
- content
- tool_use_id
- type
title: RequestBashCodeExecutionToolResultBlock
type: object
RequestCodeExecutionToolResultBlock:
additionalProperties: false
properties:
cache_control:
anyOf:
- discriminator:
mapping:
ephemeral:
$ref: '#/components/schemas/CacheControlEphemeral'
propertyName: type
oneOf:
- $ref: '#/components/schemas/CacheControlEphemeral'
- type: 'null'
description: Create a cache control breakpoint at this content block.
title: Cache Control
content:
anyOf:
- $ref: '#/components/schemas/RequestCodeExecutionToolResultError'
- $ref: '#/components/schemas/RequestCodeExecutionResultBlock'
title: Content
tool_use_id:
pattern: ^srvtoolu_[a-zA-Z0-9_]+$
title: Tool Use Id
type: string
type:
const: code_execution_tool_result
title: Type
type: string
required:
- content
- tool_use_id
- type
title: Code execution tool result
type: object
RequestContainerUploadBlock:
additionalProperties: false
description: >-
A content block that represents a file to be uploaded to the container
Files uploaded via this block will be available in the container's input
directory.
properties:
cache_control:
anyOf:
- discriminator:
mapping:
ephemeral:
$ref: '#/components/schemas/CacheControlEphemeral'
propertyName: type
oneOf:
- $ref: '#/components/schemas/CacheControlEphemeral'
- type: 'null'
description: Create a cache control breakpoint at this content block.
title: Cache Control
file_id:
title: File Id
type: string
type:
const: container_upload
title: Type
type: string
required:
- file_id
- type
title: Container upload
type: object
RequestDocumentBlock:
additionalProperties: false
properties:
cache_control:
anyOf:
- discriminator:
mapping:
ephemeral:
$ref: '#/components/schemas/CacheControlEphemeral'
propertyName: type
oneOf:
- $ref: '#/components/schemas/CacheControlEphemeral'
- type: 'null'
description: Create a cache control breakpoint at this content block.
title: Cache Control
citations:
anyOf:
- $ref: '#/components/schemas/RequestCitationsConfig'
- type: 'null'
context:
anyOf:
- minLength: 1
type: string
- type: 'null'
title: Context
source:
discriminator:
mapping:
base64:
$ref: '#/components/schemas/Base64PDFSource'
content:
$ref: '#/components/schemas/ContentBlockSource'
file:
$ref: '#/components/schemas/FileDocumentSource'
text:
$ref: '#/components/schemas/PlainTextSource'
propertyName: type
oneOf:
- $ref: '#/components/schemas/Base64PDFSource'
- $ref: '#/components/schemas/PlainTextSource'
- $ref: '#/components/schemas/ContentBlockSource'
- $ref: '#/components/schemas/FileDocumentSource'
title:
anyOf:
- maxLength: 500
minLength: 1
type: string
- type: 'null'
title: Title
type:
const: document
title: Type
type: string
required:
- source
- type
title: Document
type: object
RequestImageBlock:
additionalProperties: false
properties:
cache_control:
anyOf:
- discriminator:
mapping:
ephemeral:
$ref: '#/components/schemas/CacheControlEphemeral'
propertyName: type
oneOf:
- $ref: '#/components/schemas/CacheControlEphemeral'
- type: 'null'
description: Create a cache control breakpoint at this content block.
title: Cache Control
source:
discriminator:
mapping:
base64:
$ref: '#/components/schemas/Base64ImageSource'
file:
$ref: '#/components/schemas/FileImageSource'
propertyName: type
oneOf:
- $ref: '#/components/schemas/Base64ImageSource'
- $ref: '#/components/schemas/FileImageSource'
title: Source
type:
const: image
title: Type
type: string
required:
- source
- type
title: Image
type: object
RequestMCPToolResultBlock:
additionalProperties: false
properties:
cache_control:
anyOf:
- discriminator:
mapping:
ephemeral:
$ref: '#/components/schemas/CacheControlEphemeral'
propertyName: type
oneOf:
- $ref: '#/components/schemas/CacheControlEphemeral'
- type: 'null'
description: Create a cache control breakpoint at this content block.
title: Cache Control
content:
anyOf:
- type: string
- type: array
items:
$ref: '#/components/schemas/RequestTextBlock'
title: Content
is_error:
title: Is Error
type: boolean
tool_use_id:
pattern: ^[a-zA-Z0-9_-]+$
title: Tool Use Id
type: string
type:
const: mcp_tool_result
title: Type
type: string
required:
- tool_use_id
- type
title: MCP tool result
type: object
RequestMCPToolUseBlock:
additionalProperties: false
properties:
cache_control:
anyOf:
- discriminator:
mapping:
ephemeral:
$ref: '#/components/schemas/CacheControlEphemeral'
propertyName: type
oneOf:
- $ref: '#/components/schemas/CacheControlEphemeral'
- type: 'null'
description: Create a cache control breakpoint at this content block.
title: Cache Control
id:
pattern: ^[a-zA-Z0-9_-]+$
title: Id
type: string
input:
additionalProperties: true
title: Input
type: object
name:
title: Name
type: string
server_name:
description: The name of the MCP server
title: Server Name
type: string
type:
const: mcp_tool_use
title: Type
type: string
required:
- id
- input
- name
- server_name
- type
title: MCP tool use
type: object
RequestRedactedThinkingBlock:
additionalProperties: false
properties:
data:
title: Data
type: string
type:
const: redacted_thinking
title: Type
type: string
required:
- data
- type
title: Redacted thinking
type: object
RequestSearchResultBlock:
additionalProperties: false
properties:
cache_control:
anyOf:
- discriminator:
mapping:
ephemeral:
$ref: '#/components/schemas/CacheControlEphemeral'
propertyName: type
oneOf:
- $ref: '#/components/schemas/CacheControlEphemeral'
- type: 'null'
description: Create a cache control breakpoint at this content block.
title: Cache Control
citations:
$ref: '#/components/schemas/RequestCitationsConfig'
content:
items:
$ref: '#/components/schemas/RequestTextBlock'
title: Content
type: array
source:
title: Source
type: string
title:
title: Title
type: string
type:
const: search_result
title: Type
type: string
required:
- content
- source
- title
- type
title: Search result
type: object
RequestServerToolUseBlock:
additionalProperties: false
properties:
cache_control:
anyOf:
- discriminator:
mapping:
ephemeral:
$ref: '#/components/schemas/CacheControlEphemeral'
propertyName: type
oneOf:
- $ref: '#/components/schemas/CacheControlEphemeral'
- type: 'null'
description: Create a cache control breakpoint at this content block.
title: Cache Control
id:
pattern: ^srvtoolu_[a-zA-Z0-9_]+$
title: Id
type: string
input:
additionalProperties: true
title: Input
type: object
name:
enum:
- web_search
- web_fetch
- code_execution
- bash_code_execution
- text_editor_code_execution
title: Name
type: string
type:
const: server_tool_use
title: Type
type: string
required:
- id
- input
- name
- type
title: Server tool use
type: object
RequestTextEditorCodeExecutionToolResultBlock:
additionalProperties: false
properties:
cache_control:
anyOf:
- discriminator:
mapping:
ephemeral:
$ref: '#/components/schemas/CacheControlEphemeral'
propertyName: type
oneOf:
- $ref: '#/components/schemas/CacheControlEphemeral'
- type: 'null'
description: Create a cache control breakpoint at this content block.
title: Cache Control
content:
anyOf:
- $ref: >-
#/components/schemas/RequestTextEditorCodeExecutionToolResultError
- $ref: >-
#/components/schemas/RequestTextEditorCodeExecutionViewResultBlock
- $ref: >-
#/components/schemas/RequestTextEditorCodeExecutionCreateResultBlock
- $ref: >-
#/components/schemas/RequestTextEditorCodeExecutionStrReplaceResultBlock
title: Content
tool_use_id:
pattern: ^srvtoolu_[a-zA-Z0-9_]+$
title: Tool Use Id
type: string
type:
const: text_editor_code_execution_tool_result
title: Type
type: string
required:
- content
- tool_use_id
- type
title: RequestTextEditorCodeExecutionToolResultBlock
type: object
RequestThinkingBlock:
additionalProperties: false
properties:
signature:
title: Signature
type: string
thinking:
title: Thinking
type: string
type:
const: thinking
title: Type
type: string
required:
- signature
- thinking
- type
title: Thinking
type: object
RequestToolResultBlock:
additionalProperties: false
properties:
cache_control:
anyOf:
- discriminator:
mapping:
ephemeral:
$ref: '#/components/schemas/CacheControlEphemeral'
propertyName: type
oneOf:
- $ref: '#/components/schemas/CacheControlEphemeral'
- type: 'null'
description: Create a cache control breakpoint at this content block.
title: Cache Control
content:
anyOf:
- type: string
- items:
discriminator:
mapping:
document:
$ref: '#/components/schemas/RequestDocumentBlock'
image:
$ref: '#/components/schemas/RequestImageBlock'
search_result:
$ref: '#/components/schemas/RequestSearchResultBlock'
text:
$ref: '#/components/schemas/RequestTextBlock'
propertyName: type
oneOf:
- $ref: '#/components/schemas/RequestTextBlock'
- $ref: '#/components/schemas/RequestImageBlock'
- $ref: '#/components/schemas/RequestSearchResultBlock'
- $ref: '#/components/schemas/RequestDocumentBlock'
type: array
title: Content
is_error:
title: Is Error
type: boolean
tool_use_id:
pattern: ^[a-zA-Z0-9_-]+$
title: Tool Use Id
type: string
type:
const: tool_result
title: Type
type: string
required:
- tool_use_id
- type
title: Tool result
type: object
RequestToolUseBlock:
additionalProperties: false
properties:
cache_control:
anyOf:
- discriminator:
mapping:
ephemeral:
$ref: '#/components/schemas/CacheControlEphemeral'
propertyName: type
oneOf:
- $ref: '#/components/schemas/CacheControlEphemeral'
- type: 'null'
description: Create a cache control breakpoint at this content block.
title: Cache Control
id:
pattern: ^[a-zA-Z0-9_-]+$
title: Id
type: string
input:
additionalProperties: true
title: Input
type: object
name:
maxLength: 200
minLength: 1
title: Name
type: string
type:
const: tool_use
title: Type
type: string
required:
- id
- input
- name
- type
title: Tool use
type: object
RequestWebFetchToolResultBlock:
additionalProperties: false
properties:
cache_control:
anyOf:
- discriminator:
mapping:
ephemeral:
$ref: '#/components/schemas/CacheControlEphemeral'
propertyName: type
oneOf:
- $ref: '#/components/schemas/CacheControlEphemeral'
- type: 'null'
description: Create a cache control breakpoint at this content block.
title: Cache Control
content:
anyOf:
- $ref: '#/components/schemas/RequestWebFetchToolResultError'
- $ref: '#/components/schemas/RequestWebFetchResultBlock'
title: Content
tool_use_id:
pattern: ^srvtoolu_[a-zA-Z0-9_]+$
title: Tool Use Id
type: string
type:
const: web_fetch_tool_result
title: Type
type: string
required:
- content
- tool_use_id
- type
title: RequestWebFetchToolResultBlock
type: object
RequestWebSearchToolResultBlock:
additionalProperties: false
properties:
cache_control:
anyOf:
- discriminator:
mapping:
ephemeral:
$ref: '#/components/schemas/CacheControlEphemeral'
propertyName: type
oneOf:
- $ref: '#/components/schemas/CacheControlEphemeral'
- type: 'null'
description: Create a cache control breakpoint at this content block.
title: Cache Control
content:
anyOf:
- items:
$ref: '#/components/schemas/RequestWebSearchResultBlock'
type: array
- $ref: '#/components/schemas/RequestWebSearchToolResultError'
title: Content
tool_use_id:
pattern: ^srvtoolu_[a-zA-Z0-9_]+$
title: Tool Use Id
type: string
type:
const: web_search_tool_result
title: Type
type: string
required:
- content
- tool_use_id
- type
title: Web search tool result
type: object
SkillParams:
additionalProperties: false
description: Specification for a skill to be loaded in a container (request model).
properties:
skill_id:
description: Skill ID
maxLength: 64
minLength: 1
title: Skill Id
type: string
type:
description: >-
Type of skill - either 'anthropic' (built-in) or 'custom'
(user-defined)
enum:
- anthropic
- custom
title: Type
type: string
version:
description: Skill version or 'latest' for most recent version
maxLength: 64
minLength: 1
title: Version
type: string
required:
- skill_id
- type
title: SkillParams
type: object
ClearThinking20251015:
additionalProperties: false
properties:
keep:
anyOf:
- discriminator:
mapping:
all:
$ref: '#/components/schemas/AllThinkingTurns'
thinking_turns:
$ref: '#/components/schemas/ThinkingTurns'
propertyName: type
oneOf:
- $ref: '#/components/schemas/ThinkingTurns'
- $ref: '#/components/schemas/AllThinkingTurns'
- const: all
type: string
description: >-
Number of most recent assistant turns to keep thinking blocks for.
Older turns will have their thinking blocks removed.
title: Keep
type:
const: clear_thinking_20251015
title: Type
type: string
required:
- type
title: ClearThinking20251015
type: object
ClearToolUses20250919:
additionalProperties: false
properties:
clear_at_least:
anyOf:
- $ref: '#/components/schemas/InputTokensClearAtLeast'
- type: 'null'
description: >-
Minimum number of tokens that must be cleared when triggered.
Context will only be modified if at least this many tokens can be
removed.
clear_tool_inputs:
anyOf:
- type: boolean
- items:
type: string
type: array
- type: 'null'
description: >-
Whether to clear all tool inputs (bool) or specific tool inputs to
clear (list)
title: Clear Tool Inputs
exclude_tools:
anyOf:
- items:
type: string
type: array
- type: 'null'
description: Tool names whose uses are preserved from clearing
title: Exclude Tools
keep:
description: Number of tool uses to retain in the conversation
discriminator:
mapping:
tool_uses:
$ref: '#/components/schemas/ToolUsesKeep'
propertyName: type
oneOf:
- $ref: '#/components/schemas/ToolUsesKeep'
title: Keep
trigger:
description: Condition that triggers the context management strategy
discriminator:
mapping:
input_tokens:
$ref: '#/components/schemas/InputTokensTrigger'
tool_uses:
$ref: '#/components/schemas/ToolUsesTrigger'
propertyName: type
oneOf:
- $ref: '#/components/schemas/InputTokensTrigger'
- $ref: '#/components/schemas/ToolUsesTrigger'
title: Trigger
type:
const: clear_tool_uses_20250919
title: Type
type: string
required:
- type
title: ClearToolUses20250919
type: object
RequestMCPServerToolConfiguration:
additionalProperties: false
properties:
allowed_tools:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Allowed Tools
enabled:
anyOf:
- type: boolean
- type: 'null'
title: Enabled
title: RequestMCPServerToolConfiguration
type: object
JSONOutputFormat:
additionalProperties: false
properties:
schema:
description: JSON schema used to define Claude output.
type: object
type:
const: json_schema
title: Type
type: string
required:
- schema
- type
title: JSONOutputFormat
type: object
TokenTaskBudget:
additionalProperties: false
properties:
remaining:
description: Remaining token budget.
minimum: 0
title: Remaining
type: integer
total:
description: Total token budget across contexts.
minimum: 20000
title: Total
type: integer
type:
const: tokens
title: Type
type: string
required:
- total
- type
title: TokenTaskBudget
type: object
CacheControlEphemeral:
additionalProperties: false
properties:
type:
const: ephemeral
title: Type
type: string
required:
- type
title: CacheControlEphemeral
type: object
RequestCharLocationCitation:
additionalProperties: false
properties:
cited_text:
title: Cited Text
type: string
document_index:
minimum: 0
title: Document Index
type: integer
document_title:
anyOf:
- maxLength: 255
minLength: 1
type: string
- type: 'null'
title: Document Title
end_char_index:
title: End Char Index
type: integer
start_char_index:
minimum: 0
title: Start Char Index
type: integer
type:
const: char_location
title: Type
type: string
required:
- cited_text
- document_index
- document_title
- end_char_index
- start_char_index
- type
title: Character location
type: object
RequestContentBlockLocationCitation:
additionalProperties: false
properties:
cited_text:
title: Cited Text
type: string
document_index:
minimum: 0
title: Document Index
type: integer
document_title:
anyOf:
- maxLength: 255
minLength: 1
type: string
- type: 'null'
title: Document Title
end_block_index:
title: End Block Index
type: integer
start_block_index:
minimum: 0
title: Start Block Index
type: integer
type:
const: content_block_location
title: Type
type: string
required:
- cited_text
- document_index
- document_title
- end_block_index
- start_block_index
- type
title: Content block location
type: object
RequestPageLocationCitation:
additionalProperties: false
properties:
cited_text:
title: Cited Text
type: string
document_index:
minimum: 0
title: Document Index
type: integer
document_title:
anyOf:
- maxLength: 255
minLength: 1
type: string
- type: 'null'
title: Document Title
end_page_number:
title: End Page Number
type: integer
start_page_number:
minimum: 1
title: Start Page Number
type: integer
type:
const: page_location
title: Type
type: string
required:
- cited_text
- document_index
- document_title
- end_page_number
- start_page_number
- type
title: Page location
type: object
RequestSearchResultLocationCitation:
additionalProperties: false
properties:
cited_text:
title: Cited Text
type: string
end_block_index:
title: End Block Index
type: integer
search_result_index:
minimum: 0
title: Search Result Index
type: integer
source:
title: Source
type: string
start_block_index:
minimum: 0
title: Start Block Index
type: integer
title:
anyOf:
- type: string
- type: 'null'
title: Title
type:
const: search_result_location
title: Type
type: string
required:
- cited_text
- end_block_index
- search_result_index
- source
- start_block_index
- title
- type
title: RequestSearchResultLocationCitation
type: object
RequestWebSearchResultLocationCitation:
additionalProperties: false
properties:
cited_text:
title: Cited Text
type: string
encrypted_index:
title: Encrypted Index
type: string
title:
anyOf:
- maxLength: 512
minLength: 1
type: string
- type: 'null'
title: Title
type:
const: web_search_result_location
title: Type
type: string
url:
maxLength: 2048
minLength: 1
title: Url
type: string
required:
- cited_text
- encrypted_index
- title
- type
- url
title: RequestWebSearchResultLocationCitation
type: object
InputSchema:
additionalProperties: true
properties:
properties:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Properties
required:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Required
type:
const: object
title: Type
type: string
required:
- type
title: InputSchema
type: object
UserLocation:
additionalProperties: false
properties:
city:
anyOf:
- maxLength: 255
minLength: 1
type: string
- type: 'null'
description: The city of the user.
examples:
- New York
- Tokyo
- Los Angeles
title: City
country:
anyOf:
- maxLength: 2
minLength: 2
type: string
- type: 'null'
description: >-
The two letter [ISO country
code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user.
examples:
- US
- JP
- GB
title: Country
region:
anyOf:
- maxLength: 255
minLength: 1
type: string
- type: 'null'
description: The region of the user.
examples:
- California
- Ontario
- Wales
title: Region
timezone:
anyOf:
- maxLength: 255
minLength: 1
type: string
- type: 'null'
description: The [IANA timezone](https://nodatime.org/TimeZones) of the user.
examples:
- America/New_York
- Asia/Tokyo
- Europe/London
title: Timezone
type:
const: approximate
title: Type
type: string
required:
- type
title: UserLocation
type: object
RequestCitationsConfig:
additionalProperties: false
properties:
enabled:
title: Enabled
type: boolean
title: RequestCitationsConfig
type: object
ResponseCharLocationCitation:
properties:
cited_text:
title: Cited Text
type: string
document_index:
minimum: 0
title: Document Index
type: integer
document_title:
anyOf:
- type: string
- type: 'null'
title: Document Title
end_char_index:
title: End Char Index
type: integer
file_id:
anyOf:
- type: string
- type: 'null'
default: null
title: File Id
start_char_index:
minimum: 0
title: Start Char Index
type: integer
type:
const: char_location
default: char_location
title: Type
type: string
required:
- cited_text
- document_index
- document_title
- end_char_index
- file_id
- start_char_index
- type
title: Character location
type: object
ResponseContentBlockLocationCitation:
properties:
cited_text:
title: Cited Text
type: string
document_index:
minimum: 0
title: Document Index
type: integer
document_title:
anyOf:
- type: string
- type: 'null'
title: Document Title
end_block_index:
title: End Block Index
type: integer
file_id:
anyOf:
- type: string
- type: 'null'
default: null
title: File Id
start_block_index:
minimum: 0
title: Start Block Index
type: integer
type:
const: content_block_location
default: content_block_location
title: Type
type: string
required:
- cited_text
- document_index
- document_title
- end_block_index
- file_id
- start_block_index
- type
title: Content block location
type: object
ResponsePageLocationCitation:
properties:
cited_text:
title: Cited Text
type: string
document_index:
minimum: 0
title: Document Index
type: integer
document_title:
anyOf:
- type: string
- type: 'null'
title: Document Title
end_page_number:
title: End Page Number
type: integer
file_id:
anyOf:
- type: string
- type: 'null'
default: null
title: File Id
start_page_number:
minimum: 1
title: Start Page Number
type: integer
type:
const: page_location
default: page_location
title: Type
type: string
required:
- cited_text
- document_index
- document_title
- end_page_number
- file_id
- start_page_number
- type
title: Page location
type: object
ResponseSearchResultLocationCitation:
properties:
cited_text:
title: Cited Text
type: string
end_block_index:
title: End Block Index
type: integer
search_result_index:
minimum: 0
title: Search Result Index
type: integer
source:
title: Source
type: string
start_block_index:
minimum: 0
title: Start Block Index
type: integer
title:
anyOf:
- type: string
- type: 'null'
title: Title
type:
const: search_result_location
default: search_result_location
title: Type
type: string
required:
- cited_text
- end_block_index
- search_result_index
- source
- start_block_index
- title
- type
title: ResponseSearchResultLocationCitation
type: object
ResponseWebSearchResultLocationCitation:
properties:
cited_text:
title: Cited Text
type: string
encrypted_index:
title: Encrypted Index
type: string
title:
anyOf:
- maxLength: 512
type: string
- type: 'null'
title: Title
type:
const: web_search_result_location
default: web_search_result_location
title: Type
type: string
url:
title: Url
type: string
required:
- cited_text
- encrypted_index
- title
- type
- url
title: ResponseWebSearchResultLocationCitation
type: object
ResponseWebSearchToolResultError:
properties:
error_code:
$ref: '#/components/schemas/WebSearchToolResultErrorCode'
type:
const: web_search_tool_result_error
default: web_search_tool_result_error
title: Type
type: string
required:
- error_code
- type
title: ResponseWebSearchToolResultError
type: object
ResponseWebSearchResultBlock:
properties:
encrypted_content:
title: Encrypted Content
type: string
page_age:
anyOf:
- type: string
- type: 'null'
default: null
title: Page Age
title:
title: Title
type: string
type:
const: web_search_result
default: web_search_result
title: Type
type: string
url:
title: Url
type: string
required:
- encrypted_content
- page_age
- title
- type
- url
title: ResponseWebSearchResultBlock
type: object
ResponseWebFetchToolResultError:
properties:
error_code:
$ref: '#/components/schemas/WebFetchToolResultErrorCode'
type:
const: web_fetch_tool_result_error
default: web_fetch_tool_result_error
title: Type
type: string
required:
- error_code
- type
title: ResponseWebFetchToolResultError
type: object
ResponseWebFetchResultBlock:
properties:
content:
$ref: '#/components/schemas/ResponseDocumentBlock'
retrieved_at:
anyOf:
- type: string
- type: 'null'
default: null
description: ISO 8601 timestamp when the content was retrieved
title: Retrieved At
type:
const: web_fetch_result
default: web_fetch_result
title: Type
type: string
url:
description: Fetched content URL
title: Url
type: string
required:
- content
- retrieved_at
- type
- url
title: ResponseWebFetchResultBlock
type: object
ResponseCodeExecutionToolResultError:
properties:
error_code:
$ref: '#/components/schemas/CodeExecutionToolResultErrorCode'
type:
const: code_execution_tool_result_error
default: code_execution_tool_result_error
title: Type
type: string
required:
- error_code
- type
title: Code execution tool error
type: object
ResponseCodeExecutionResultBlock:
properties:
content:
items:
$ref: '#/components/schemas/ResponseCodeExecutionOutputBlock'
title: Content
type: array
return_code:
title: Return Code
type: integer
stderr:
title: Stderr
type: string
stdout:
title: Stdout
type: string
type:
const: code_execution_result
default: code_execution_result
title: Type
type: string
required:
- content
- return_code
- stderr
- stdout
- type
title: Code execution result
type: object
ResponseBashCodeExecutionToolResultError:
properties:
error_code:
$ref: '#/components/schemas/BashCodeExecutionToolResultErrorCode'
type:
const: bash_code_execution_tool_result_error
default: bash_code_execution_tool_result_error
title: Type
type: string
required:
- error_code
- type
title: ResponseBashCodeExecutionToolResultError
type: object
ResponseBashCodeExecutionResultBlock:
properties:
content:
items:
$ref: '#/components/schemas/ResponseBashCodeExecutionOutputBlock'
title: Content
type: array
return_code:
title: Return Code
type: integer
stderr:
title: Stderr
type: string
stdout:
title: Stdout
type: string
type:
const: bash_code_execution_result
default: bash_code_execution_result
title: Type
type: string
required:
- content
- return_code
- stderr
- stdout
- type
title: ResponseBashCodeExecutionResultBlock
type: object
ResponseTextEditorCodeExecutionToolResultError:
properties:
error_code:
$ref: '#/components/schemas/TextEditorCodeExecutionToolResultErrorCode'
error_message:
anyOf:
- type: string
- type: 'null'
default: null
title: Error Message
type:
const: text_editor_code_execution_tool_result_error
default: text_editor_code_execution_tool_result_error
title: Type
type: string
required:
- error_code
- error_message
- type
title: ResponseTextEditorCodeExecutionToolResultError
type: object
ResponseTextEditorCodeExecutionViewResultBlock:
properties:
content:
title: Content
type: string
file_type:
enum:
- text
- image
- pdf
title: File Type
type: string
num_lines:
anyOf:
- type: integer
- type: 'null'
default: null
title: Num Lines
start_line:
anyOf:
- type: integer
- type: 'null'
default: null
title: Start Line
total_lines:
anyOf:
- type: integer
- type: 'null'
default: null
title: Total Lines
type:
const: text_editor_code_execution_view_result
default: text_editor_code_execution_view_result
title: Type
type: string
required:
- content
- file_type
- num_lines
- start_line
- total_lines
- type
title: ResponseTextEditorCodeExecutionViewResultBlock
type: object
ResponseTextEditorCodeExecutionCreateResultBlock:
properties:
is_file_update:
title: Is File Update
type: boolean
type:
const: text_editor_code_execution_create_result
default: text_editor_code_execution_create_result
title: Type
type: string
required:
- is_file_update
- type
title: ResponseTextEditorCodeExecutionCreateResultBlock
type: object
ResponseTextEditorCodeExecutionStrReplaceResultBlock:
properties:
lines:
anyOf:
- items:
type: string
type: array
- type: 'null'
default: null
title: Lines
new_lines:
anyOf:
- type: integer
- type: 'null'
default: null
title: New Lines
new_start:
anyOf:
- type: integer
- type: 'null'
default: null
title: New Start
old_lines:
anyOf:
- type: integer
- type: 'null'
default: null
title: Old Lines
old_start:
anyOf:
- type: integer
- type: 'null'
default: null
title: Old Start
type:
const: text_editor_code_execution_str_replace_result
default: text_editor_code_execution_str_replace_result
title: Type
type: string
required:
- lines
- new_lines
- new_start
- old_lines
- old_start
- type
title: ResponseTextEditorCodeExecutionStrReplaceResultBlock
type: object
CacheCreation:
properties:
ephemeral_1h_input_tokens:
default: 0
description: The number of input tokens used to create the 1 hour cache entry.
minimum: 0
title: Ephemeral 1H Input Tokens
type: integer
ephemeral_5m_input_tokens:
default: 0
description: The number of input tokens used to create the 5 minute cache entry.
minimum: 0
title: Ephemeral 5M Input Tokens
type: integer
required:
- ephemeral_1h_input_tokens
- ephemeral_5m_input_tokens
title: CacheCreation
type: object
ServerToolUsage:
properties:
web_fetch_requests:
default: 0
description: The number of web fetch tool requests.
examples:
- 2
minimum: 0
title: Web Fetch Requests
type: integer
web_search_requests:
default: 0
description: The number of web search tool requests.
examples:
- 0
minimum: 0
title: Web Search Requests
type: integer
required:
- web_fetch_requests
- web_search_requests
title: ServerToolUsage
type: object
ResponseClearThinking20251015Edit:
properties:
cleared_input_tokens:
description: Number of input tokens cleared by this edit.
minimum: 0
title: Cleared Input Tokens
type: integer
cleared_thinking_turns:
description: Number of thinking turns that were cleared.
minimum: 0
title: Cleared Thinking Turns
type: integer
type:
const: clear_thinking_20251015
default: clear_thinking_20251015
description: The type of context management edit applied.
title: Type
type: string
required:
- cleared_input_tokens
- cleared_thinking_turns
- type
title: ResponseClearThinking20251015Edit
type: object
ResponseClearToolUses20250919Edit:
properties:
cleared_input_tokens:
description: Number of input tokens cleared by this edit.
minimum: 0
title: Cleared Input Tokens
type: integer
cleared_tool_uses:
description: Number of tool uses that were cleared.
minimum: 0
title: Cleared Tool Uses
type: integer
type:
const: clear_tool_uses_20250919
default: clear_tool_uses_20250919
description: The type of context management edit applied.
title: Type
type: string
required:
- cleared_input_tokens
- cleared_tool_uses
- type
title: ResponseClearToolUses20250919Edit
type: object
Skill:
description: A skill that was loaded in a container (response model).
properties:
skill_id:
description: Skill ID
maxLength: 64
minLength: 1
title: Skill Id
type: string
type:
description: >-
Type of skill - either 'anthropic' (built-in) or 'custom'
(user-defined)
enum:
- anthropic
- custom
title: Type
type: string
version:
description: Skill version or 'latest' for most recent version
maxLength: 64
minLength: 1
title: Version
type: string
required:
- skill_id
- type
- version
title: Skill
type: object
RequestBashCodeExecutionToolResultError:
additionalProperties: false
properties:
error_code:
$ref: '#/components/schemas/BashCodeExecutionToolResultErrorCode'
type:
const: bash_code_execution_tool_result_error
title: Type
type: string
required:
- error_code
- type
title: RequestBashCodeExecutionToolResultError
type: object
RequestBashCodeExecutionResultBlock:
additionalProperties: false
properties:
content:
items:
$ref: '#/components/schemas/RequestBashCodeExecutionOutputBlock'
title: Content
type: array
return_code:
title: Return Code
type: integer
stderr:
title: Stderr
type: string
stdout:
title: Stdout
type: string
type:
const: bash_code_execution_result
title: Type
type: string
required:
- content
- return_code
- stderr
- stdout
- type
title: RequestBashCodeExecutionResultBlock
type: object
RequestCodeExecutionToolResultError:
additionalProperties: false
properties:
error_code:
$ref: '#/components/schemas/CodeExecutionToolResultErrorCode'
type:
const: code_execution_tool_result_error
title: Type
type: string
required:
- error_code
- type
title: Code execution tool error
type: object
RequestCodeExecutionResultBlock:
additionalProperties: false
properties:
content:
items:
$ref: '#/components/schemas/RequestCodeExecutionOutputBlock'
title: Content
type: array
return_code:
title: Return Code
type: integer
stderr:
title: Stderr
type: string
stdout:
title: Stdout
type: string
type:
const: code_execution_result
title: Type
type: string
required:
- content
- return_code
- stderr
- stdout
- type
title: Code execution result
type: object
Base64PDFSource:
additionalProperties: false
properties:
data:
format: byte
title: Data
type: string
media_type:
const: application/pdf
title: Media Type
type: string
type:
const: base64
title: Type
type: string
required:
- data
- media_type
- type
title: PDF (base64)
type: object
ContentBlockSource:
additionalProperties: false
properties:
content:
anyOf:
- type: string
- items:
discriminator:
mapping:
image:
$ref: '#/components/schemas/RequestImageBlock'
text:
$ref: '#/components/schemas/RequestTextBlock'
propertyName: type
oneOf:
- $ref: '#/components/schemas/RequestTextBlock'
- $ref: '#/components/schemas/RequestImageBlock'
type: array
title: Content
type:
const: content
title: Type
type: string
required:
- content
- type
title: Content block
type: object
FileDocumentSource:
additionalProperties: false
properties:
file_id:
title: File Id
type: string
type:
const: file
title: Type
type: string
required:
- file_id
- type
title: File document
type: object
PlainTextSource:
additionalProperties: false
properties:
data:
title: Data
type: string
media_type:
const: text/plain
title: Media Type
type: string
type:
const: text
title: Type
type: string
required:
- data
- media_type
- type
title: Plain text
type: object
Base64ImageSource:
additionalProperties: false
properties:
data:
format: byte
title: Data
type: string
media_type:
enum:
- image/jpeg
- image/png
- image/gif
- image/webp
title: Media Type
type: string
type:
const: base64
title: Type
type: string
required:
- data
- media_type
- type
title: Base64ImageSource
type: object
FileImageSource:
additionalProperties: false
properties:
file_id:
title: File Id
type: string
type:
const: file
title: Type
type: string
required:
- file_id
- type
title: FileImageSource
type: object
RequestTextEditorCodeExecutionToolResultError:
additionalProperties: false
properties:
error_code:
$ref: '#/components/schemas/TextEditorCodeExecutionToolResultErrorCode'
error_message:
anyOf:
- type: string
- type: 'null'
title: Error Message
type:
const: text_editor_code_execution_tool_result_error
title: Type
type: string
required:
- error_code
- type
title: RequestTextEditorCodeExecutionToolResultError
type: object
RequestTextEditorCodeExecutionViewResultBlock:
additionalProperties: false
properties:
content:
title: Content
type: string
file_type:
enum:
- text
- image
- pdf
title: File Type
type: string
num_lines:
anyOf:
- type: integer
- type: 'null'
title: Num Lines
start_line:
anyOf:
- type: integer
- type: 'null'
title: Start Line
total_lines:
anyOf:
- type: integer
- type: 'null'
title: Total Lines
type:
const: text_editor_code_execution_view_result
title: Type
type: string
required:
- content
- file_type
- type
title: RequestTextEditorCodeExecutionViewResultBlock
type: object
RequestTextEditorCodeExecutionCreateResultBlock:
additionalProperties: false
properties:
is_file_update:
title: Is File Update
type: boolean
type:
const: text_editor_code_execution_create_result
title: Type
type: string
required:
- is_file_update
- type
title: RequestTextEditorCodeExecutionCreateResultBlock
type: object
RequestTextEditorCodeExecutionStrReplaceResultBlock:
additionalProperties: false
properties:
lines:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Lines
new_lines:
anyOf:
- type: integer
- type: 'null'
title: New Lines
new_start:
anyOf:
- type: integer
- type: 'null'
title: New Start
old_lines:
anyOf:
- type: integer
- type: 'null'
title: Old Lines
old_start:
anyOf:
- type: integer
- type: 'null'
title: Old Start
type:
const: text_editor_code_execution_str_replace_result
title: Type
type: string
required:
- type
title: RequestTextEditorCodeExecutionStrReplaceResultBlock
type: object
RequestWebFetchToolResultError:
additionalProperties: false
properties:
error_code:
$ref: '#/components/schemas/WebFetchToolResultErrorCode'
type:
const: web_fetch_tool_result_error
title: Type
type: string
required:
- error_code
- type
title: RequestWebFetchToolResultError
type: object
RequestWebFetchResultBlock:
additionalProperties: false
properties:
content:
$ref: '#/components/schemas/RequestDocumentBlock'
retrieved_at:
anyOf:
- type: string
- type: 'null'
description: ISO 8601 timestamp when the content was retrieved
title: Retrieved At
type:
const: web_fetch_result
title: Type
type: string
url:
description: Fetched content URL
title: Url
type: string
required:
- content
- type
- url
title: RequestWebFetchResultBlock
type: object
RequestWebSearchResultBlock:
additionalProperties: false
properties:
encrypted_content:
title: Encrypted Content
type: string
page_age:
anyOf:
- type: string
- type: 'null'
title: Page Age
title:
title: Title
type: string
type:
const: web_search_result
title: Type
type: string
url:
title: Url
type: string
required:
- encrypted_content
- title
- type
- url
title: RequestWebSearchResultBlock
type: object
RequestWebSearchToolResultError:
additionalProperties: false
properties:
error_code:
$ref: '#/components/schemas/WebSearchToolResultErrorCode'
type:
const: web_search_tool_result_error
title: Type
type: string
required:
- error_code
- type
title: RequestWebSearchToolResultError
type: object
AllThinkingTurns:
additionalProperties: false
properties:
type:
const: all
title: Type
type: string
required:
- type
title: AllThinkingTurns
type: object
ThinkingTurns:
additionalProperties: false
properties:
type:
const: thinking_turns
title: Type
type: string
value:
minimum: 1
title: Value
type: integer
required:
- type
- value
title: ThinkingTurns
type: object
InputTokensClearAtLeast:
additionalProperties: false
properties:
type:
const: input_tokens
title: Type
type: string
value:
minimum: 0
title: Value
type: integer
required:
- type
- value
title: InputTokensClearAtLeast
type: object
ToolUsesKeep:
additionalProperties: false
properties:
type:
const: tool_uses
title: Type
type: string
value:
minimum: 0
title: Value
type: integer
required:
- type
- value
title: ToolUsesKeep
type: object
InputTokensTrigger:
additionalProperties: false
properties:
type:
const: input_tokens
title: Type
type: string
value:
minimum: 1
title: Value
type: integer
required:
- type
- value
title: InputTokensTrigger
type: object
ToolUsesTrigger:
additionalProperties: false
properties:
type:
const: tool_uses
title: Type
type: string
value:
minimum: 1
title: Value
type: integer
required:
- type
- value
title: ToolUsesTrigger
type: object
WebSearchToolResultErrorCode:
enum:
- invalid_tool_input
- unavailable
- max_uses_exceeded
- too_many_requests
- query_too_long
title: WebSearchToolResultErrorCode
type: string
WebFetchToolResultErrorCode:
enum:
- invalid_tool_input
- url_too_long
- url_not_allowed
- url_not_accessible
- unsupported_content_type
- too_many_requests
- max_uses_exceeded
- unavailable
title: WebFetchToolResultErrorCode
type: string
ResponseDocumentBlock:
properties:
citations:
anyOf:
- $ref: '#/components/schemas/ResponseCitationsConfig'
- type: 'null'
default: null
description: Citation configuration for the document
source:
discriminator:
mapping:
base64:
$ref: '#/components/schemas/Base64PDFSource'
text:
$ref: '#/components/schemas/PlainTextSource'
propertyName: type
oneOf:
- $ref: '#/components/schemas/Base64PDFSource'
- $ref: '#/components/schemas/PlainTextSource'
title: Source
title:
anyOf:
- type: string
- type: 'null'
default: null
description: The title of the document
title: Title
type:
const: document
default: document
title: Type
type: string
required:
- citations
- source
- title
- type
title: ResponseDocumentBlock
type: object
CodeExecutionToolResultErrorCode:
enum:
- invalid_tool_input
- unavailable
- too_many_requests
- execution_time_exceeded
title: CodeExecutionToolResultErrorCode
type: string
ResponseCodeExecutionOutputBlock:
properties:
file_id:
title: File Id
type: string
type:
const: code_execution_output
default: code_execution_output
title: Type
type: string
required:
- file_id
- type
title: ResponseCodeExecutionOutputBlock
type: object
BashCodeExecutionToolResultErrorCode:
enum:
- invalid_tool_input
- unavailable
- too_many_requests
- execution_time_exceeded
- output_file_too_large
title: BashCodeExecutionToolResultErrorCode
type: string
ResponseBashCodeExecutionOutputBlock:
properties:
file_id:
title: File Id
type: string
type:
const: bash_code_execution_output
default: bash_code_execution_output
title: Type
type: string
required:
- file_id
- type
title: ResponseBashCodeExecutionOutputBlock
type: object
TextEditorCodeExecutionToolResultErrorCode:
enum:
- invalid_tool_input
- unavailable
- too_many_requests
- execution_time_exceeded
- file_not_found
title: TextEditorCodeExecutionToolResultErrorCode
type: string
RequestBashCodeExecutionOutputBlock:
additionalProperties: false
properties:
file_id:
title: File Id
type: string
type:
const: bash_code_execution_output
title: Type
type: string
required:
- file_id
- type
title: RequestBashCodeExecutionOutputBlock
type: object
RequestCodeExecutionOutputBlock:
additionalProperties: false
properties:
file_id:
title: File Id
type: string
type:
const: code_execution_output
title: Type
type: string
required:
- file_id
- type
title: RequestCodeExecutionOutputBlock
type: object
ResponseCitationsConfig:
properties:
enabled:
default: false
title: Enabled
type: boolean
required:
- enabled
title: ResponseCitationsConfig
type: object
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: >-
##All APIs require Bearer Token authentication##
**Get API Key:**
Visit [API Key Management Page](https://evolink.ai/dashboard/keys) to
get your API Key
**Add to request header:**
```
Authorization: Bearer YOUR_API_KEY
```
````