Responses

List responses

Returns the AI responses collected in the active project, optionally filtered to a single prompt. The response is paginated, with the newest returned first by default.

GET /api/v1/responses

Query parameters

Name Type Required Description
page integer Optional

The page number to return. Defaults to 1.

per_page integer Optional

The number of items per page. Defaults to 25, maximum 100.

prompt_id integer Optional

Limit results to responses belonging to a single prompt.

sort_by string Optional

The column to sort by. Defaults to created_at.

sort_order string Optional

The direction to sort by. Each endpoint has its own default.

include string Optional

A comma-separated list of related resources to include in the response. Allowed values: prompt, prompt.monitor, prompt.monitor.project, prompt.monitor.project.organization, monitor, monitor.project, monitor.project.organization, project, project.organization.

Response

Response schema

Field Type Description
data Response[]
links PaginationLinks
meta PaginationMeta

The response object

Field Type Description
id integer

The unique ID of the response.

prompt_text string

The exact prompt text the engine was given.

platform string

The AI engine that produced this answer.

model string

The model identifier reported by the engine.

country string

The ISO 3166-1 alpha-2 country code the response was run in.

language string

The language the response was run in.

content string

The raw markdown content the engine produced.

html string

The rendered HTML form of the content, suitable for display.

excerpt string

A whitespace-collapsed plain-text excerpt of the content, suitable for list views.

search_queries string[]

The web search queries the engine ran while producing this answer, if any.

created_at datetime

When the response was recorded.

updated_at datetime

When the response was last updated.