Skip to content
API Documents/LLM API/
/WebSearchTool

create

Request

Security
ApiKeyAuth
Bodyapplication/json
dataobjectrequired
curl -i -X POST \
  https://llm-api.treasuredata.com/api/web_search_tools \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "type": "webSearchTools",
      "attributes": {
        "projectId": "00000000-0000-0000-0000-000000000001",
        "name": "Sample Web Search Tool",
        "modelType": "gpt-5",
        "searchContextSize": "medium",
        "userLocation": {
          "type": "approximate",
          "country": "JP",
          "city": "Minato",
          "region": "Tokyo",
          "timezone": "Asia/Tokyo"
        },
        "systemPrompt": "You are a helpful search assistant.",
        "filters": {
          "allowed_domains": [
            "medical.example.test",
            "research.example.test",
            "health.example.test"
          ]
        }
      }
    }
  }'

Responses

creates a new WebSearchTool

Bodyapplication/vnd.api+json
dataobjectrequired
Response
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000001",
    "type": "webSearchTools",
    "links": { … },
    "attributes": { … }
  }
}