Messages(Web search)

POST

/v1/messages

Request

Header Params

Body Params application/json

Example

{
    "model": "claude-3-7-sonnet-20250219",
    "max_tokens": 1024,
    "messages": [
        {
            "role": "user",
            "content": "How do I update a web app to TypeScript 5.5?"
        }
    ],
    "tools": [
        {
            "type": "web_search_20250305",
            "name": "web_search",
            "max_uses": 5
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/v1/messages' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model": "claude-3-7-sonnet-20250219",
    "max_tokens": 1024,
    "messages": [
        {
            "role": "user",
            "content": "How do I update a web app to TypeScript 5.5?"
        }
    ],
    "tools": [
        {
            "type": "web_search_20250305",
            "name": "web_search",
            "max_uses": 5
        }
    ]
}'

Responses

🟢200OK

application/json

Body

Example

{
    "id": "chatcmpl-89D7UVB9Lac3rIZD7Wgt69AT33Njf",
    "type": "message",
    "role": "assistant",
    "content": [
        {
            "type": "text",
            "text": " I don't see any image in your message. Could you please upload or share the image you'd like me to describe? Once you do, I'll be happy to provide a detailed description of what I see."
        }
    ],
    "stop_reason": "end_turn",
    "model": "claude-sonnet-4-20250514",
    "usage": {
        "input_tokens": 96,
        "cache_creation_input_tokens": 0,
        "cache_read_input_tokens": 0,
        "output_tokens": 43
    }
}

Modified at 2025-06-13 15:24:34

Messages(function call)

Create chat completion (streaming)