v1

latestSwagger 2.02026-07-17184180523.4 KB
relay

Create response

Create a new response

post/v1/responses

Headers

Aiproxy-Channelstring

Optional Aiproxy-Channel header

Request body

backgroundboolean
{"stackTrail":"components:schemas:model.CreateResponseRequest:properties:conversation","oasType":"schema","type":"unknown","description":"string or object"}
includestring[]
{"stackTrail":"components:schemas:model.CreateResponseRequest:properties:input","oasType":"schema","type":"unknown"}
instructionsstring
max_output_tokensinteger
max_tool_callsinteger
metadataobject
modelstring
parallel_tool_callsboolean
previous_response_idstring
prompt_cache_keystring
prompt_cache_retentionstring
safety_identifierstring
service_tierstring
storeboolean
streamboolean
temperaturenumber
{"stackTrail":"components:schemas:model.CreateResponseRequest:properties:tool_choice","oasType":"schema","type":"unknown"}
top_logprobsinteger
top_pnumber
truncationstring
userstring

Deprecated, use prompt_cache_key

Response

OK

backgroundboolean
created_atinteger
idstring
instructionsstring
max_output_tokensinteger
metadataobject
modelstring
objectstring
parallel_tool_callsboolean
previous_response_idstring
prompt_cache_retentionstring
service_tierstring
status'in_progress' | 'queued' | 'completed' | 'failed' | 'incomplete' | 'cancelled'
storeboolean
temperaturenumber
{"stackTrail":"components:schemas:model.Response:properties:tool_choice","oasType":"schema","type":"unknown"}
top_pnumber
truncationstring
userstring