Sign in

v19

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-084091267.1 KB
Extract

Extract

Extracts relevant content from specific web URLs.

The legacy Extract API reference (/v1beta/extract endpoint) is available here, and migration guide is here.

post/v1/extract

Request body

urlsstring[] required

URLs to extract content from. Up to 20 URLs.

objectivestring nullable

As in SearchRequest, a natural-language description of the underlying question or goal driving the request. Used together with search_queries to focus excerpts on the most relevant content.

search_queriesstring[] nullable

Optional keyword search queries, as in SearchRequest. Used together with objective to focus excerpts on the most relevant content.

max_chars_totalinteger nullable

Upper bound on total characters across excerpts from all extracted results.

session_idstring nullable

Session identifier to track calls across separate search and extract calls, to be used as part of a larger task. Specifying it may give better contextual results for subsequent API calls.

client_modelstring nullable

The model generating this request and consuming the results. Enables optimizations and tailors default settings for the model's capabilities.

Example request

{
  "client_model": "claude-opus-4-7",
  "advanced_settings": {
    "fetch_policy": {
      "max_age_seconds": 86400,
      "timeout_seconds": 60
    }
  }
}

Response

Successful Response

extract_idstring required

Extract request ID, e.g. extract_cad0a6d2dec046bd95ae900527d880e7

session_idstring required

Session identifier. Echoed back from the request if provided, otherwise generated by the server. Should be passed to future search and extract calls made by the agent as part of the same larger task.

Example response

{
  "warnings": [
    {
      "type": "spec_validation_warning"
    }
  ],
  "usage": [
    {
      "name": "sku_search_additional_results",
      "count": 1
    }
  ],
  "session_id": "session_8a911eb27c7a4afaa20d0d9dc98d07c0"
}