Skip to main content

WebSearchToolResponse

Structured response returned by the web-search tool endpoint.

queryQuery (string)required

Original search query.

results object[]

Structured search results ordered by provider relevance.

  • Array [
  • titleTitle (string)required

    Human-readable page title.

    urlUrl (string)required

    Canonical result URL.

    snippetSnippet (string)required

    Short result snippet suitable for tool context.

  • ]
  • providerProvider (string)required

    Backend provider implementation that produced the results.

    WebSearchToolResponse
    {
    "query": "string",
    "results": [
    {
    "title": "string",
    "url": "string",
    "snippet": "string"
    }
    ],
    "provider": "string"
    }