Skip to main content
POST
/
v1
/
messages
Anthropic messages
curl --request POST \
  --url https://api.example.com/v1/messages \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "max_tokens": 256,
  "messages": [
    {
      "content": [
        {
          "text": "Explain nordlys routing.",
          "type": "text"
        }
      ],
      "role": "user"
    }
  ],
  "metadata": {
    "user_id": {}
  },
  "model": "claude-sonnet-4-5",
  "models": [
    "<string>"
  ],
  "provider_configs": {},
  "provider_data_collection": "<string>",
  "provider_enforce_distillable_text": true,
  "provider_ignore": [
    "<string>"
  ],
  "provider_max_completion_price": 123,
  "provider_max_image_price": 123,
  "provider_max_prompt_price": 123,
  "provider_max_request_price": 123,
  "provider_only": [
    "<string>"
  ],
  "provider_order": [
    "<string>"
  ],
  "provider_quantizations": [
    "<string>"
  ],
  "provider_require_parameters": true,
  "provider_sort": "<string>",
  "provider_zdr": true,
  "service_tier": "<string>",
  "stop_sequences": [
    "<string>"
  ],
  "stream": false,
  "system": [
    {
      "cache_control": {
        "ttl": "<string>",
        "type": "<string>"
      },
      "citations": [
        {
          "OfCharLocation": {
            "cited_text": "<string>",
            "document_index": 123,
            "document_title": {},
            "end_char_index": 123,
            "start_char_index": 123,
            "type": "<string>"
          },
          "OfContentBlockLocation": {
            "cited_text": "<string>",
            "document_index": 123,
            "document_title": {},
            "end_block_index": 123,
            "start_block_index": 123,
            "type": "<string>"
          },
          "OfPageLocation": {
            "cited_text": "<string>",
            "document_index": 123,
            "document_title": {},
            "end_page_number": 123,
            "start_page_number": 123,
            "type": "<string>"
          },
          "OfSearchResultLocation": {
            "cited_text": "<string>",
            "end_block_index": 123,
            "search_result_index": 123,
            "source": "<string>",
            "start_block_index": 123,
            "title": {},
            "type": "<string>"
          },
          "OfWebSearchResultLocation": {
            "cited_text": "<string>",
            "encrypted_index": "<string>",
            "title": {},
            "type": "<string>",
            "url": "<string>"
          }
        }
      ],
      "text": "<string>",
      "type": "<string>"
    }
  ],
  "temperature": {},
  "thinking": {
    "OfDisabled": {
      "type": "<string>"
    },
    "OfEnabled": {
      "budget_tokens": 123,
      "type": "<string>"
    }
  },
  "tool_choice": {
    "OfAny": {
      "disable_parallel_tool_use": {},
      "type": "<string>"
    },
    "OfAuto": {
      "disable_parallel_tool_use": {},
      "type": "<string>"
    },
    "OfNone": {
      "type": "<string>"
    },
    "OfTool": {
      "disable_parallel_tool_use": {},
      "name": "<string>",
      "type": "<string>"
    }
  },
  "tools": [
    {
      "OfBashTool20250124": {
        "cache_control": {
          "ttl": "<string>",
          "type": "<string>"
        },
        "name": "<string>",
        "type": "<string>"
      },
      "OfTextEditor20250124": {
        "cache_control": {
          "ttl": "<string>",
          "type": "<string>"
        },
        "name": "<string>",
        "type": "<string>"
      },
      "OfTextEditor20250429": {
        "cache_control": {
          "ttl": "<string>",
          "type": "<string>"
        },
        "name": "<string>",
        "type": "<string>"
      },
      "OfTextEditor20250728": {
        "cache_control": {
          "ttl": "<string>",
          "type": "<string>"
        },
        "max_characters": {},
        "name": "<string>",
        "type": "<string>"
      },
      "OfTool": {
        "cache_control": {
          "ttl": "<string>",
          "type": "<string>"
        },
        "description": {},
        "input_schema": {
          "properties": "<unknown>",
          "required": [
            "<string>"
          ],
          "type": "<string>"
        },
        "name": "<string>",
        "type": "<string>"
      },
      "OfWebSearchTool20250305": {
        "allowed_domains": [
          "<string>"
        ],
        "blocked_domains": [
          "<string>"
        ],
        "cache_control": {
          "ttl": "<string>",
          "type": "<string>"
        },
        "max_uses": {},
        "name": "<string>",
        "type": "<string>",
        "user_location": {
          "city": {},
          "country": {},
          "region": {},
          "timezone": {},
          "type": "<string>"
        }
      }
    }
  ],
  "top_k": {},
  "top_p": {}
}
'
{
  "content": [
    {
      "citations": [
        {
          "cited_text": "<string>",
          "document_index": 123,
          "document_title": "<string>",
          "encrypted_index": "<string>",
          "end_block_index": 123,
          "end_char_index": 123,
          "end_page_number": 123,
          "file_id": "<string>",
          "search_result_index": 123,
          "source": "<string>",
          "start_block_index": 123,
          "start_char_index": 123,
          "start_page_number": 123,
          "title": "<string>",
          "type": "<string>",
          "url": "<string>"
        }
      ],
      "content": {
        "OfWebSearchResultBlockArray": [
          {
            "encrypted_content": "<string>",
            "page_age": "<string>",
            "title": "<string>",
            "type": "<string>",
            "url": "<string>"
          }
        ],
        "error_code": "<string>",
        "type": "<string>"
      },
      "data": "<string>",
      "id": "<string>",
      "input": "<unknown>",
      "name": "<string>",
      "signature": "<string>",
      "text": "<string>",
      "thinking": "<string>",
      "tool_use_id": "<string>",
      "type": "<string>"
    }
  ],
  "id": "<string>",
  "model": "<string>",
  "role": "<string>",
  "stop_reason": "<string>",
  "stop_sequence": "<string>",
  "type": "<string>",
  "usage": {
    "cache_creation": {
      "ephemeral_1h_input_tokens": 123,
      "ephemeral_5m_input_tokens": 123
    },
    "cache_creation_input_tokens": 123,
    "cache_read_input_tokens": 123,
    "input_tokens": 123,
    "output_tokens": 123,
    "server_tool_use": {
      "web_search_requests": 123
    },
    "service_tier": "<string>"
  }
}

Authorizations

X-API-Key
string
header
required

Headers

anthropic-beta
string[]

Body

application/json
max_tokens
integer<int64>
Example:

256

messages
object[] | null
Example:
[
{
"content": [
{
"text": "Explain nordlys routing.",
"type": "text"
}
],
"role": "user"
}
]
metadata
object
model
string
Example:

"claude-sonnet-4-5"

models
string[] | null
provider_configs
object
provider_data_collection
string
provider_enforce_distillable_text
boolean | null
provider_ignore
string[] | null
provider_max_completion_price
number | null
provider_max_image_price
number | null
provider_max_prompt_price
number | null
provider_max_request_price
number | null
provider_only
string[] | null
provider_order
string[] | null
provider_quantizations
string[] | null
provider_require_parameters
boolean
provider_sort
string
provider_zdr
boolean | null
service_tier
string
stop_sequences
string[] | null
stream
boolean
Example:

false

system
object[] | null
temperature
object
thinking
object
tool_choice
object
tools
object[] | null
top_k
object
top_p
object

Response

200 - application/json

OK

content
object[] | null
id
string
model
string
role
string
stop_reason
string
stop_sequence
string
type
string
usage
object