Skip to navigation

Responses

View as Markdown

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

Generated from CreateResponse plus Sikaru extensions; unknown fields are rejected.

modelstringRequired
streamtrueRequired
access_programsmap from strings to any or nullOptional
backgroundboolean or nullOptional
context_managementlist of maps from strings to any or nullOptional
conversationstring or map from strings to any or nullOptional
includelist of strings or nullOptional
inputstring or list of maps from strings to any or nullOptional
instructionsstring or nullOptional
max_output_tokensinteger or nullOptional
max_tool_callsinteger or nullOptional
metadatamap from strings to any or nullOptional
modelslist of strings or nullOptional
moderationmap from strings to any or nullOptional
parallel_tool_callsboolean or nullOptional
previous_response_idstring or nullOptional<=16384 characters
promptmap from strings to any or nullOptional
prompt_cache_keystring or nullOptional<=1024 characters
prompt_cache_optionsmap from strings to any or nullOptional
prompt_cache_retentionstring or nullOptional
providermap from strings to any or nullOptional
reasoningmap from strings to any or nullOptional
routestring or nullOptional
safety_identifierstring or nullOptional<=128 characters
service_tierstring or nullOptional
storeboolean or nullOptional
stream_optionsmap from strings to any or nullOptional
temperaturedouble or nullOptional0-2
textmap from strings to any or nullOptional
tool_choicestring or map from strings to any or nullOptional
toolslist of maps from strings to any or nullOptional
top_logprobsinteger or nullOptional0-20
top_pdouble or nullOptional0-1
transformslist of strings or nullOptional
truncationstring or nullOptional
usagemap from strings to any or nullOptional
userstring or nullOptional

Response

annotationmap from strings to any or nullOptional
annotation_indexinteger or nullOptional
argumentsstring or nullOptional
codestring or nullOptional
commandstring or nullOptional
command_indexinteger or nullOptional
content_indexinteger or nullOptional
deltastring or map from strings to any or nullOptional
inputstring or nullOptional
itemmap from strings to any or nullOptional
item_idstring or nullOptional
logprobslist of maps from strings to any or nullOptional
messagestring or nullOptional
outputlist of maps from strings to any or nullOptional
output_formatstring or nullOptional
output_indexinteger or nullOptional
paramstring or nullOptional
partmap from strings to any or nullOptional
partial_image_b64string or nullOptional
partial_image_indexinteger or nullOptional
qualitystring or nullOptional
refusalstring or nullOptional
responseobject or nullOptional

Public Response fields at this level (RESPONSE_FIELDS); the projection omits the rest.

sequence_numberinteger or nullOptional
sizestring or nullOptional
statusstring or nullOptional
summary_indexinteger or nullOptional
textstring or nullOptional
typestring or nullOptional