Skip to main content
POST
extract

Request contract

Complete OpenAPI definition Effective request and pricing declaration (including authentication and referenced schemas):

Cost and request rules

Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.
  • Default request reference estimate (USD): 0.02
  • Cost contract: response_count
  • Published reference multiplier: 1.0
  • Settlement evidence source: response_body

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Extract request.

urls
string[]
required

URLs to extract content from. Up to 20 URLs.

advanced_settings
AdvancedExtractSettings · object | null

Advanced configuration for fetch policy, excerpt settings, and full content settings. May impact result quality and latency unless used carefully. When omitted, excerpts are enabled and full content is disabled by default.

client_model
string | null

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

Example:

"claude-opus-4-7"

max_chars_total
integer | null

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

objective
string | null

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_queries
string[] | null

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

session_id
string | null

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.

Maximum string length: 1000

Response

Successful Response

Extract response.

errors
ExtractError · object[]
required

Extract errors: requested URLs not in the results.

extract_id
string
required

Extract request ID, e.g. extract_cad0a6d2dec046bd95ae900527d880e7

results
V1ExtractResult · object[]
required

Successful extract results.

session_id
string
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:

"session_8a911eb27c7a4afaa20d0d9dc98d07c0"

usage
UsageItem · object[] | null

Usage metrics for the extract request.

warnings
Warning · object[] | null

Warnings for the extract request, if any.