Web Search | PrivateGPT

{
  "content": [
    {
      "sources": [
        {
          "content": "Full markdown content from the source...",
          "content_type": "text/markdown",
          "description": "Brief description of the page content",
          "favicon_url": "https://example.com/favicon.png",
          "id": "website_a1f2ae32-e661-4f61-ad94-7f26163b51da",
          "object": "context.website",
          "title": "Example Page Title",
          "url": "https://example.com/page"
        }
      ],
      "type": "source"
    },
    {
      "text": "1. Example Page Title\nDescription: Brief description...\nURL: https://example.com/page\nAge: Unknown\nContent: Full content preview...",
      "type": "text"
    }
  ],
  "is_error": false
}

Search the web for information related to a natural language query and return aggregated results from multiple sources.

Request

Request body for web search. Includes the natural language query to search the web.

querystringRequired

The natural language query to search the web.

Response

Web search completed successfully.

contentlist of objects

List of content blocks generated by the tool. Blocks can include plain text, citations, source attributions, or images.

is_errorbooleanDefaults to false

True if the tool encountered an error during execution.

Errors

401

Unauthorized Error

422

Unprocessable Entity Error

$	curl -X POST /v1/tools/web-search \
>	-H "Content-Type: application/json" \
>	-d '{
>	"query": "Latest news on AI advancements"
>	}'