Skip to main content
The TypeScript SDK and docs are currently in beta. Report issues on GitHub.

Example Usage

import { OpenResponsesRequestPluginWeb } from "@openrouter/sdk/models";

let value: OpenResponsesRequestPluginWeb = {
  id: "web",
};

Fields

FieldTypeRequiredDescription
id”web”:heavy_check_mark:N/A
enabledboolean:heavy_minus_sign:Set to false to disable the web-search plugin for this request. Defaults to true.
maxResultsnumber:heavy_minus_sign:N/A
searchPromptstring:heavy_minus_sign:N/A
enginemodels.WebSearchEngine:heavy_minus_sign:The search engine to use for web search.