DOC-API-MODEL-schema-1g3q0m5uun#overview
PluginWebConfig
Provider web-search configuration used to augment a generation request.
Type-reference view: API Schema 9frhv4euve, API Schema 9ftjkkjhfa. Request and response views describe this type; they do not declare an endpoint.
Meaning and usage
Section ID: DOC-API-MODEL-schema-1g3q0m5uun#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1g3q0m5uun#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-1g3q0m5uun#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1g3q0m5uun#request-field-engineengine | string | Optional | See meaning below. |
Section ID: DOC-API-MODEL-schema-1g3q0m5uun#request-field-maxresultsmaxResults | string (int64) | Optional | Maximum web-search result count requested by the plugin. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1g3q0m5uun#request-field-searchpromptsearchPrompt | string | Optional | Instructions supplied to the web-search plugin. |
Section ID: DOC-API-MODEL-schema-1g3q0m5uun#request-field-websearchoptionswebSearchOptions | WebSearchOptions | Optional | Options controlling the amount of web-search context requested. |
engine
Search engine selected for the provider’s web-search plugin.
e.g., native/exa
In responses
Section ID: DOC-API-MODEL-schema-1g3q0m5uun#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1g3q0m5uun#field-engineSection ID: DOC-API-MODEL-schema-1g3q0m5uun#response-field-engineengine | string | Optional | See meaning below. |
Section ID: DOC-API-MODEL-schema-1g3q0m5uun#field-maxresultsSection ID: DOC-API-MODEL-schema-1g3q0m5uun#response-field-maxresultsmaxResults | string (int64) | Optional | Maximum web-search result count requested by the plugin. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1g3q0m5uun#field-searchpromptSection ID: DOC-API-MODEL-schema-1g3q0m5uun#response-field-searchpromptsearchPrompt | string | Optional | Instructions supplied to the web-search plugin. |
Section ID: DOC-API-MODEL-schema-1g3q0m5uun#field-websearchoptionsSection ID: DOC-API-MODEL-schema-1g3q0m5uun#response-field-websearchoptionswebSearchOptions | WebSearchOptions | Optional | Options controlling the amount of web-search context requested. |
engine
Search engine selected for the provider’s web-search plugin.
e.g., native/exa
Where used
Section ID: DOC-API-MODEL-schema-1g3q0m5uun#where-used
| Reference | Relationship |
|---|---|
| Create an agent profile | POST /api/v1/agent-profiles/create |
| Get an agent profile | POST /api/v1/agent-profiles/get |
| Import a prompt library | POST /api/v1/agent-profiles/import |
| List agent profiles | POST /api/v1/agent-profiles/list |
| Update an agent profile | POST /api/v1/agent-profiles/update |
| 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 |
| Send a message and wait for the result | POST /api/v1/llm/send-message-sync |
| Submit client-side tool results and wait for the next segment | POST /api/v1/llm/submit-client-tool-results-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 |
| Get the caller's end-user profile | POST /api/v1/enduser/get |
| 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 |
| Update the caller's default generation config | POST /api/v1/enduser/update-generation-config |
| ReceiveMessageRequest | API JSON uses JSON field names (camelCase). |
| ClientToolDispatch | API JSON uses JSON field names (camelCase). |
Models containing this value
| Model | Relationship |
|---|---|
| PluginConfig | Nested in model |
| PluginConfig | Nested in model |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-1g3q0m5uun