Skip to main content
POST
Create Quick Read
Send page URL context only. Do not send the full page body from the browser. The API looks up indexed content for the URL and returns not_found when the page is not available in the published index.
Use max_bullets to control the number of takeaways. The endpoint supports published by default and unpublished when you are testing runtime package changes before publishing.

Body

application/json
​
company
string
required

Public company or index identifier.

​
canonical_url
string
required

Canonical URL of the page to summarize.

​
page_url
string

Current browser URL. Optional; fragments and tracking params are normalized server-side.

​
title
string

Optional page title for display and prompt context.

​
locale
string

Optional locale or language hint.

​
requestId
string

Caller-generated request identifier.

​
sessionId
string

Caller-generated session identifier.

​
is_private_session
boolean
default:false

When true, skips cache and private-session-aware logging.

​
model
string
default:gpt

Model alias configured for the runtime package.

​
version
enum<string>
default:published

Runtime package pointer. Omit this field or use published for production traffic. Use unpublished only when testing an unpublished runtime package.

Available options:
published,
unpublished
​
max_bullets
integer
default:3

Maximum number of Quick Read bullets to return.

Required range: 1 <= x <= 5

Response

Quick Read result for the supplied page URL

​
status
enum<string>
required

Quick Read generation status.

Available options:
ready,
not_found,
error
​
bullets
string[]
required

Concise page takeaways. Empty when status is not_found.

​
cache_status
enum<string>
required

Whether the response came from cache.

Available options:
hit,
miss,
bypass
​
source_url
string | null

Normalized source URL used for lookup.

​
title
string | null

Page title returned by the request or indexed content.

​
version
enum<string>
default:published

Runtime package pointer. Omit this field or use published for production traffic. Use unpublished only when testing an unpublished runtime package.

Available options:
published,
unpublished
​
resolved_version
string | null

Resolved runtime pointer after fallback handling.

​
resolved_corpus_version
integer | null

Resolved indexed corpus version used internally for the response.

​
generated_at
string<date-time> | null

Server timestamp for the generated response.