🚨 Open Responses API (Alpha). Learn more here
🚨 Open Responses API (Alpha). Learn more here
A valid request URL is required to generate request examples{
"created_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"choices": [
{
"index": 123,
"delta": {
"role": "user",
"tool_call_id": "<string>",
"content": "<string>",
"name": "<string>",
"tool_calls": []
},
"finish_reason": "stop",
"logprobs": {
"content": [
{
"token": "<string>",
"logprob": 123,
"top_logprobs": [
{
"token": "<string>",
"logprob": 123,
"bytes": [
123
]
}
],
"bytes": [
123
]
}
]
},
"tool_calls": [
{
"function": {
"name": "<string>",
"arguments": "<string>"
},
"type": "function",
"integration": "<unknown>",
"system": "<unknown>",
"api_call": "<unknown>",
"computer_20241022": {
"action": "key",
"text": "<string>",
"coordinate": [
123
]
},
"text_editor_20241022": {
"command": "str_replace",
"path": "<string>",
"file_text": "<string>",
"insert_line": 123,
"new_str": "<string>",
"old_str": "<string>",
"view_range": [
123
]
},
"bash_20241022": {
"command": "<string>",
"restart": false
},
"id": "<string>"
}
]
}
],
"usage": {
"completion_tokens": 123,
"prompt_tokens": 123,
"total_tokens": 123
},
"jobs": [],
"docs": []
}Initiates a chat session.
Routes to different implementations based on feature flags:
Parameters: developer (Developer): The developer associated with the chat session. session_id (UUID): The unique identifier of the chat session. chat_input (ChatInput): The chat input data. background_tasks (BackgroundTasks): The background tasks to run. x_custom_api_key (Optional[str]): The custom API key. mock_response (Optional[str]): Mock response for testing. connection_pool: Connection pool for testing purposes.
Returns: ChatResponse or StreamingResponse: The chat response or streaming response.
A valid request URL is required to generate request examples{
"created_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"choices": [
{
"index": 123,
"delta": {
"role": "user",
"tool_call_id": "<string>",
"content": "<string>",
"name": "<string>",
"tool_calls": []
},
"finish_reason": "stop",
"logprobs": {
"content": [
{
"token": "<string>",
"logprob": 123,
"top_logprobs": [
{
"token": "<string>",
"logprob": 123,
"bytes": [
123
]
}
],
"bytes": [
123
]
}
]
},
"tool_calls": [
{
"function": {
"name": "<string>",
"arguments": "<string>"
},
"type": "function",
"integration": "<unknown>",
"system": "<unknown>",
"api_call": "<unknown>",
"computer_20241022": {
"action": "key",
"text": "<string>",
"coordinate": [
123
]
},
"text_editor_20241022": {
"command": "str_replace",
"path": "<string>",
"file_text": "<string>",
"insert_line": 123,
"new_str": "<string>",
"old_str": "<string>",
"view_range": [
123
]
},
"bash_20241022": {
"command": "<string>",
"restart": false
},
"id": "<string>"
}
]
}
],
"usage": {
"completion_tokens": 123,
"prompt_tokens": 123,
"total_tokens": 123
},
"jobs": [],
"docs": []
}1Show child attributes
user, assistant, system, tool Show child attributes
"function"Show child attributes
key, type, cursor_position, mouse_move, left_click, right_click, middle_click, double_click, screenshot Show child attributes
str_replace, insert, view, undo_edit Show child attributes
40function, integration, system, api_call, computer_20241022, text_editor_20241022, bash_20241022 System definition
Show child attributes
agent, user, task, execution, doc, session, job create, update, patch, create_or_update, embed, change_status, search, chat, history, delete, get, list tool, doc, execution, transition API call definition
Show child attributes
GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, CONNECT, TRACE 1JSON Schema for API call parameters
Show child attributes
Show child attributes
Property definition for parameter schema
Anthropic new tools
Show child attributes
"computer_20241022"x >= 600x >= 4001 <= x <= 10auto, none 1204-1 <= x <= 1000x >= 10 <= x <= 20 <= x <= 20 <= x <= 1-2 <= x <= 2-2 <= x <= 20 <= x <= 50 <= x <= 1Successful Response
Show child attributes
The message generated by the model
Show child attributes
user, assistant, system, tool Show child attributes
"function"Show child attributes
key, type, cursor_position, mouse_move, left_click, right_click, middle_click, double_click, screenshot Show child attributes
str_replace, insert, view, undo_edit stop, length, content_filter, tool_calls Show child attributes
Show child attributes
Show child attributes
"function"Show child attributes
key, type, cursor_position, mouse_move, left_click, right_click, middle_click, double_click, screenshot Show child attributes
str_replace, insert, view, undo_edit Show child attributes