PluginWebConfig
Provider web-search configuration used to augment a generation request.
Usage profiles
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
| In webhook payloads | View fields |
In requests
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
engine | string | Optional | Search engine selected for the provider’s web-search plugin. |
maxResults | integer (int32) | Optional | Maximum web-search result count requested by the plugin. Minimum: -2147483648. Maximum: 2147483647. |
searchPrompt | string | Optional | Instructions supplied to the web-search plugin. |
webSearchOptions | WebSearchOptions | Optional | Options controlling the amount of web-search context requested. |
In responses
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
engine | string | Optional | Search engine selected for the provider’s web-search plugin. |
maxResults | integer (int32) | Optional | Maximum web-search result count requested by the plugin. Minimum: -2147483648. Maximum: 2147483647. |
searchPrompt | string | Optional | Instructions supplied to the web-search plugin. |
webSearchOptions | WebSearchOptions | Optional | Options controlling the amount of web-search context requested. |
In webhook payloads
Webhook JSON uses protobuf field names (snake_case).
| Field | Type | Presence | Meaning |
|---|---|---|---|
engine | string | Optional | Search engine selected for the provider’s web-search plugin. |
max_results | integer (int32) | Optional | Maximum web-search result count requested by the plugin. Minimum: -2147483648. Maximum: 2147483647. |
search_prompt | string | Optional | Instructions supplied to the web-search plugin. |
web_search_options | WebSearchOptions | Optional | Options controlling the amount of web-search context requested. |
Where used
| Reference | Relationship |
|---|---|
| Create an agent profile | POST /api/v1/agent-profiles/create |
| Import a prompt library | POST /api/v1/agent-profiles/import |
| Update an agent profile | POST /api/v1/agent-profiles/update |
| Append a message without generating | POST /api/v1/llm/append-message |
| Create a new conversation thread | POST /api/v1/llm/create-thread |
| Send a message to a conversation | POST /api/v1/llm/send-message |
| Send a message and wait for the result | POST /api/v1/llm/send-message-sync |
| Update context management settings | POST /api/v1/llm/update-context-management-settings |
| Update default generation config | POST /api/v1/llm/update-default-generation-config |
| Update the caller's default generation config | POST /api/v1/enduser/update-generation-config |
| Get an agent profile | POST /api/v1/agent-profiles/get |
| List agent profiles | POST /api/v1/agent-profiles/list |
| Withdraw your rating on a message | POST /api/v1/llm/delete-message-rating |
| Get full conversation state | POST /api/v1/llm/conversation-state |
| Rate an assistant message | POST /api/v1/llm/rate-message |
| Submit client-side tool results and wait for the next segment | POST /api/v1/llm/submit-client-tool-results-sync |
| Get the caller's end-user profile | POST /api/v1/enduser/get |
| Generation configuration | API JSON uses JSON field names (camelCase). |
| llm.generation_started | Webhook JSON uses protobuf field names (snake_case). |
| llm.message_published | Webhook JSON uses protobuf field names (snake_case). |
| PluginConfig | Nested in model |
| PluginConfig | Nested in model |
| PluginConfig | Nested in model |
Download the public reference contract.
Document: DOC-API-MODEL-plugin-web-config.