Responses

Get a response

Returns a single response. The response must belong to the active project.

GET /api/v1/responses/{response}

Path parameters

Name Type Required Description
response integer Required

The numeric ID of the response.

Query parameters

Name Type Required Description
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

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.