API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Responses

Create a grounded response (streaming)

client.responses.create(ResponseCreateParams { input, effort, model, 2 more } body, RequestOptionsoptions?): ResponseCreateResponse

POST/v1/responses

ModelsExpand Collapse

CollectedSourceSummary { author, favicon, image, 8 more }

author: string | null

favicon: string | null

image: string | null

published_date: string | null

query_index: number

query_indices: Array<number>

result_index: number

score: number | null

title: string

url: string

providers?: Array<string>

Provider names that returned this URL (admin-only).

Snippet { source_index, text, verified, num }

source_index: number

text: string

The relevant passage extracted from the source.

verified: boolean

Whether the snippet text was verified as a substring of the source document.

num?: number

Sequential number assigned to verified snippets (1-based). Unverified snippets have no num.