Skip to content

Create Response

POST

/v1/responses

Create one Responses API-compatible agent response.

Parameters

Header Parameters

X-Admin-Key

Any of:

string
null

string

X-Admin-API-Key

Any of:

string
null

string

X-Project-ID

Any of:

string
null

string

Request Body^required

ResponsesRequest

Open Responses-compatible request body.

object

background

Background

boolean

conversation

Any of:

string
null

string

include

Any of:

Array<string>
null

Array<string>

input

Input

""

instructions

Any of:

string
null

string

max_output_tokens

Any of:

integer
null

integer

>= 1 <= 8000

metadata

Metadata

object

key

additional properties

any

model

required

Model

string

parallel_tool_calls

Parallel Tool Calls

boolean

default: true

previous_response_id

Any of:

string
null

string

reasoning_effort

Any of:

string
null

string

Allowed values: low medium high

store

Store

boolean

default: true

stream

Stream

boolean

temperature

Any of:

number
null

number

<= 2

text

Any of:

object
null

object

key

additional properties

any

tool_choice

Any of:

unknown
null

tools

Any of:

Array<object>
null

Array<object>

object

key

additional properties

any

top_p

Any of:

number
null

number

<= 1

truncation

Any of:

string
null

string

Allowed values: disabled auto

user

Any of:

string
null

string

>= 1 characters <= 200 characters

key

additional properties

any

Responses

200

Successful Response

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string