Web Search

Some provider endpoints support hosted web search. In an OpenAI-compatible Planck request, enable it with a plugins entry whose id is web.

Web search is endpoint-specific. Check supportedPlugins or supportsWebSearch in the model response before sending the request. A model route that does not advertise the web plugin may reject it.

Quickstart

This example locks routing to the Anthropic endpoint because the plugin is a provider capability.

Python
TypeScript
cURL

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["PLANCK_API_KEY"],
    base_url="https://api.inquantum.ai/v1",
)

response = client.chat.completions.create(
    model="claude-4.6-sonnet/anthropic",
    messages=[
        {"role": "user", "content": "What changed in today's AI news? Cite sources."}
    ],
    extra_body={
        "plugins": [{"id": "web", "max_uses": 3}]
    },
)

print(response.choices[0].message.content)
print(response.choices[0].message.annotations)

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.PLANCK_API_KEY,
  baseURL: "https://api.inquantum.ai/v1",
});

const response = await client.chat.completions.create({
  model: "claude-4.6-sonnet/anthropic",
  messages: [
    { role: "user", content: "What changed in today's AI news? Cite sources." },
  ],
  plugins: [{ id: "web", max_uses: 3 }],
} as OpenAI.Chat.Completions.ChatCompletionCreateParamsNonStreaming & {
  plugins: Array<Record<string, unknown>>;
});

console.log(response.choices[0].message.content);
console.log(response.choices[0].message.annotations);

curl https://api.inquantum.ai/v1/chat/completions \
  -H "Authorization: Bearer $PLANCK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "claude-4.6-sonnet/anthropic",
    "messages": [
      {
        "role": "user",
        "content": "What changed in recent AI news? Cite sources."
      }
    ],
    "plugins": [{ "id": "web", "max_uses": 3 }]
  }'

Plugin options

Field	Type	Description
`id`	string	Required. Use `web`.
`max_uses`	integer	Maximum searches the provider may run for this request.
`allowed_domains`	string[]	Limit results to these domains.
`blocked_domains`	string[]	Exclude these domains.
`user_location`	object	Approximate location information for localized results.

allowed_domains and blocked_domains are mutually exclusive in most provider implementations; send only the restriction your application needs.

Citations and usage

Search-enabled responses can include URL citations in message.annotations. Provider usage can also include server_tool_use.web_search_requests. Treat both fields as optional because their presence depends on whether the model searched and on the selected compatibility route. Web search charges are provider-specific and are added to token usage. Review the selected endpoint in the model registry before enabling it in production.

Get Started

Models & Inference

Reliability & Controls

Observability

Prompt Management

Integrations

Quickstart

Plugin options

Citations and usage

​Quickstart

​Plugin options

​Citations and usage

Quickstart

Plugin options

Citations and usage