Create Response

Create a response. This will generate an LLM or agentic response. At this time the only supported model is deep-search. Responses may be streamed or returned synchronously. The retrieve tool is currently the only supported tool, more tools will be added in the future. A single partition may be provided in the retrieve tool. If omitted the default partition is used.

Request body

inputstring required

The text used to generate the response. Generally a question or a query.

instructionsstring nullable

The instructions inserted in the prompt. For this agent, the instructions are injected during search related steps.

model'deep-search'

The model to use for the agent. Currently the only model is deep-search.

streamboolean

Whether to stream the response

Response

Successful Response

idstring required

object'response'

created_atinteger required

status'completed' | 'failed' | 'in_progress' | 'cancelled' required

errorstring nullable

{"stackTrail":"components:schemas:Response:properties:incomplete_details","oasType":"schema","type":"unknown","title":"Incomplete Details"}

instructionsstring nullable

{"stackTrail":"components:schemas:Response:properties:max_output_tokens","oasType":"schema","type":"unknown","title":"Max Output Tokens"}

model'deep-search'

parallel_tool_callsboolean

storeboolean

temperaturenumber

previous_response_idstring nullable

tool_choice'auto'

top_pnumber

truncation'disabled'

{"stackTrail":"components:schemas:Response:properties:user","oasType":"schema","type":"unknown","title":"User"}

metadataobject

v1

Create Response

Request body

Response