Create OpenResponse

OpenResponses endpoint backed by Arrow. The endpoint is stateless: previous_response_id may only be null and store may only be false, so a prior turn is continued by replaying it in input. Caller-declared function and custom tools are returned as function_call and custom_tool_call output items for the caller to execute and replay. Streaming ends with the literal [DONE] transport sentinel.

POST/v1/responses

Authorization

AuthorizationBearer token · headerrequired

Authentication via Bearer token API key

Header parameters

x-trace-idstring

Optional client-supplied trace identifier. The API echoes this value in `X-Trace-ID` and includes it in request logs for client-side correlation.

min length 1 · max length 256

Request body

requiredapplication/json

frequency_penaltynumber

min -2 · max 2

inputstring | object[]required

Show properties

Any of:

string

string

object[]

Array of object

Any of:

object

contentstring | object[]required

Show properties

Any of:

string

string

object[]

Array of object

Any of:

object

textstringrequired

typestringrequired

Allowed:input_text

object

detailstring

Allowed:lowhighautooriginal

file_idstring | null

image_urlstring | null

refstring | null

typestringrequired

Allowed:input_image

object

detailstring | null

Allowed:autolowhighnull

file_datastring | null

file_idstring | null

file_urlstring | null

filenamestring | null

typestringrequired

Allowed:input_file

object

annotationsobject[] | null

textstringrequired

typestringrequired

Allowed:output_text

object

refusalstringrequired

typestringrequired

Allowed:refusal

idstring | null

phasestring | null

Allowed:commentaryfinal_answernull

rolestringrequired

Allowed:assistantdevelopersystemuser

statusstring | null

Allowed:in_progresscompletedincompletenull

typestring

Allowed:message

object

argumentsstring

call_idstringrequired

min length 1

idstring | null

namestringrequired

min length 1

statusstring | null

Allowed:in_progresscompletedincompletenull

typestringrequired

Allowed:function_call

object

call_idstringrequired

min length 1

idstring | null

outputstring | object[]required

Show properties

Any of:

string

string

object[]

Array of object

Any of:

object

textstringrequired

typestringrequired

Allowed:input_text

object

detailstring | null

Allowed:lowhighautooriginalnull

file_idstring | null

image_urlstring | null

refstring | null

typestringrequired

Allowed:input_image

object

detailstring | null

Allowed:autolowhighnull

file_datastring | null

file_idstring | null

file_urlstring | null

filenamestring | null

typestringrequired

Allowed:input_file

statusstring | null

Allowed:in_progresscompletedincompletenull

typestringrequired

Allowed:function_call_output

object

call_idstringrequired

min length 1

idstring | null

inputstring

namestringrequired

min length 1

statusstring | null

Allowed:in_progresscompletedincompletenull

typestringrequired

Allowed:custom_tool_call

object

call_idstringrequired

min length 1

idstring | null

outputstring | object[]required

Show properties

Any of:

string

string

object[]

Array of object

textstringrequired

typestringrequired

Allowed:input_text

statusstring | null

Allowed:in_progresscompletedincompletenull

typestringrequired

Allowed:custom_tool_call_output

object

contentany

encrypted_contentstring | null

matches ^rs_[A-Za-z0-9_-]{80,256}$

idstring | null

matches ^rs_[A-Za-z0-9_-]{80,256}$

statusstring | null

Allowed:completed

summaryobject[] | null

Show properties

Array of object

textstringrequired

typestring

Allowed:summary_text

typestring

Allowed:reasoning

object

rolestring | null

Allowed:developersystemusernull

toolsobject[]

typestringrequired

Allowed:additional_tools

instructionsstring | null

max_output_tokensinteger | null

max_tool_callsinteger | null

metadataobject

modelstringrequired

min length 1

parallel_tool_callsboolean

presence_penaltynumber

min -2 · max 2

previous_response_idany

The endpoint is stateless and holds no prior response to continue from; only `null` is accepted. Continue a conversation by replaying the earlier items in `input`.

prompt_cache_keystring | null

reasoningobject

Show properties

effortstring

Allowed:lowmediumhighxhigh

summarystring | null

Allowed:auto

storeboolean

The endpoint is stateless and never persists a response, so `store` may only be `false`. Omitting it means the same thing.

Allowed:false

streamboolean

stream_optionsobject

Show properties

include_obfuscationboolean

temperaturenumber

min 0 · max 2

textobject

Show properties

formatobject

Show properties

typestring

Allowed:text

verbositystring

Allowed:lowmediumhigh

tool_choicestring | object

Show properties

Any of:

string

string

object

namestringrequired

min length 1

typestringrequired

Allowed:function

object

namestringrequired

min length 1

typestringrequired

Allowed:custom

object

modestringrequired

Allowed:autorequired

toolsobject[]required

min items 1

Show properties

Array of object

Any of:

object

namestringrequired

min length 1

typestringrequired

Allowed:function

object

namestringrequired

min length 1

typestringrequired

Allowed:custom

typestringrequired

Allowed:allowed_tools

toolsobject[] | null

Show properties

Array of object

Any of:

object

descriptionstring | null

namestringrequired

min length 1

parametersobject | null

strictboolean

typestringrequired

Allowed:function

object

descriptionstring | null

formatobject | any

Show properties

One of:

object

typestring

Allowed:text

object

definitionstringrequired

min length 1

syntaxstringrequired

Allowed:larkregex

typestringrequired

Allowed:grammar

any

any

namestringrequired

min length 1

typestringrequired

Allowed:custom

top_pnumber

min 0 · max 1

Responses

200OpenResponses-compatible ResponseResource returned by the upstream inference service.

backgroundboolean

Allowed:false

completed_atinteger | null

created_atintegerrequired

errorobject | null

Show properties

codestringrequired

Show properties

Any of:

string

string

string

string

messagestringrequired

quiver_codestring | null

Allowed:invalid_requestmodel_not_foundunsupported_animation_requestimage_dimensions_too_largemissing_reference_imagetoo_many_reference_imagestoo_many_subjectsartwork_ids_mismatchinvalid_image_urlimage_url_restrictedimage_url_unresolvedimage_fetch_failedimage_payload_too_largeinvalid_image_payloadunsupported_image_referenceinvalid_svg_sourcesvg_too_largecontent_policy_violationrate_limitedrequest_timeoutupstream_errorinternal_errornull

reasonstring | null

Allowed:max_tool_callstool_failurerequired_tool_missingprovider_incompletenull

status_codeinteger | null

typestring | null

Allowed:invalid_request_error

frequency_penaltynumber

idstringrequired

incomplete_detailsobject | null

Show properties

codestring | null

messagestring | null

reasonstringrequired

Allowed:content_filtermax_output_tokens

status_codeinteger | null

instructionsstring | nullrequired

max_output_tokensinteger | nullrequired

max_tool_callsinteger | null

metadataobjectrequired

modelstringrequired

objectstring

Allowed:response

outputobject[]required

Show properties

Array of object

Any of:

object

argumentsstring

call_idstringrequired

min length 1

idstringrequired

namestringrequired

min length 1

statusstring

Allowed:completedincomplete

typestring

Allowed:function_call

object

call_idstringrequired

min length 1

idstringrequired

inputstring

namestringrequired

min length 1

statusstring

Allowed:completedincomplete

typestring

Allowed:custom_tool_call

object

call_idstringrequired

min length 1

idstringrequired

outputstringrequired

statusstring

Allowed:completed

typestring

Allowed:function_call_output

object

encrypted_contentstring | null

matches ^rs_[A-Za-z0-9_-]{80,256}$

idstringrequired

matches ^rs_[A-Za-z0-9_-]{80,256}$

statusstring

Allowed:completed

summaryobject[]required

Show properties

Array of object

textstringrequired

typestring

Allowed:summary_text

typestring

Allowed:reasoning

object

contentobject[]required

Show properties

Array of object

annotationsobject[]

logprobsobject[]

textstringrequired

typestring

Allowed:output_text

idstringrequired

phasestring

Allowed:commentaryfinal_answer

rolestring

Allowed:assistant

statusstring

Allowed:completed

typestring

Allowed:message

parallel_tool_callsboolean

presence_penaltynumberrequired

previous_response_idstring | null

prompt_cache_keystring | null

reasoningobject

Show properties

effortstring

Allowed:lowmediumhighxhigh

summarystring | null

Allowed:auto

safety_identifierstring | null

service_tierstring

Allowed:default

statusstring

Allowed:completedincompletefailed

storebooleanrequired

temperaturenumberrequired

textobject

Show properties

formatobject

Show properties

typestring

Allowed:text

verbositystring

Allowed:lowmediumhigh

tool_choicestring | objectrequired

Show properties

Any of:

string

string

object

namestringrequired

min length 1

typestringrequired

Allowed:function

object

namestringrequired

min length 1

typestringrequired

Allowed:custom

object

modestringrequired

Allowed:autorequired

toolsobject[]required

min items 1

Show properties

Array of object

Any of:

object

namestringrequired

min length 1

typestringrequired

Allowed:function

object

namestringrequired

min length 1

typestringrequired

Allowed:custom

typestringrequired

Allowed:allowed_tools

toolsobject[]

Show properties

Array of object

Any of:

object

descriptionstring | null

namestringrequired

min length 1

parametersobject | null

strictboolean

typestringrequired

Allowed:function

object

descriptionstring | null

formatobject | any

Show properties

One of:

object

typestring

Allowed:text

object

definitionstringrequired

min length 1

syntaxstringrequired

Allowed:larkregex

typestringrequired

Allowed:grammar

any

any

namestringrequired

min length 1

typestringrequired

Allowed:custom

top_logprobsinteger

top_pnumberrequired

truncationstring

Allowed:disabled

usageobject | null

Show properties

input_tokensintegerrequired

input_tokens_detailsobjectrequired

Show properties

cache_write_tokensintegerrequired

cached_tokensintegerrequired

output_tokensintegerrequired

output_tokens_detailsobjectrequired

Show properties

reasoning_tokensintegerrequired

total_tokensintegerrequired

400Bad request – malformed body, missing required fields, or invalid parameter values.

codestringrequired

Allowed:invalid_requestinvalid_api_keyunauthorizedfunding_payment_failedfunding_payment_method_requiredfunding_payment_action_requiredfunding_pendinginsufficient_creditsaccount_frozencontent_policy_violationmodel_not_foundpayload_too_largerequest_timeoutrate_limit_exceededoperation_rate_limit_exceededweekly_limit_exceededserver_errormodel_errormodel_unavailable

messagestringrequired

min length 1

request_idstringrequired

min length 1

retry_afterinteger

min 0 · max 86400

statusintegerrequired

min 400 · max 599

401Unauthorized – missing, malformed, revoked, otherwise invalid API credentials, or an organization that could not be resolved for billing.

codestringrequired

messagestringrequired

min length 1

request_idstringrequired

min length 1

retry_afterinteger

min 0 · max 86400

statusintegerrequired

min 400 · max 599

402Payment required – the organization has insufficient credits.

codestringrequired

messagestringrequired

min length 1

request_idstringrequired

min length 1

retry_afterinteger

min 0 · max 86400

statusintegerrequired

min 400 · max 599

403Forbidden – the account is frozen, the request is not allowed, or content policy rejected the request.

codestringrequired

messagestringrequired

min length 1

request_idstringrequired

min length 1

retry_afterinteger

min 0 · max 86400

statusintegerrequired

min 400 · max 599

404Not found – the requested model does not exist.

codestringrequired

messagestringrequired

min length 1

request_idstringrequired

min length 1

retry_afterinteger

min 0 · max 86400

statusintegerrequired

min 400 · max 599

408Request timeout – the request exceeded an allowed client-facing deadline.

codestringrequired

messagestringrequired

min length 1

request_idstringrequired

min length 1

retry_afterinteger

min 0 · max 86400

statusintegerrequired

min 400 · max 599

413Payload too large – the submitted prompt, image, or SVG input is too large.

codestringrequired

messagestringrequired

min length 1

request_idstringrequired

min length 1

retry_afterinteger

min 0 · max 86400

statusintegerrequired

min 400 · max 599

429Rate limit exceeded – request throughput or measured input/output token usage exhausted a binding ceiling. `operation_rate_limit_exceeded` identifies operation throughput; `rate_limit_exceeded` covers overall request and token rates. `X-RateLimit-Dimension` names the exact dimension. When `Retry-After` is present, retry after the indicated period.

codestringrequired

messagestringrequired

min length 1

request_idstringrequired

min length 1

retry_afterinteger

min 0 · max 86400

statusintegerrequired

min 400 · max 599

500The request could not be completed. Please retry.

codestringrequired

messagestringrequired

min length 1

request_idstringrequired

min length 1

retry_afterinteger

min 0 · max 86400

statusintegerrequired

min 400 · max 599

502Bad gateway – model execution returned an invalid or failed response.

codestringrequired

messagestringrequired

min length 1

request_idstringrequired

min length 1

retry_afterinteger

min 0 · max 86400

statusintegerrequired

min 400 · max 599

503Service unavailable – model execution is temporarily unavailable.

codestringrequired

messagestringrequired

min length 1

request_idstringrequired

min length 1

retry_afterinteger

min 0 · max 86400

statusintegerrequired

min 400 · max 599

504Gateway timeout – model execution exceeded the server deadline.

codestringrequired

messagestringrequired

min length 1

request_idstringrequired

min length 1

retry_afterinteger

min 0 · max 86400

statusintegerrequired

min 400 · max 599

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

x-trace-idheaderOptional client-supplied trace identifier. The API echoes this value in `X-Trace-ID` and includes it in request logs for client-side correlation.

Bodyapplication/json

Request body

Request

curl -X POST "https://api.quiver.ai/v1/responses" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "frequency_penalty": -2,
  "input": "string",
  "instructions": "string",
  "max_output_tokens": 0,
  "max_tool_calls": 0,
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "model": "string",
  "parallel_tool_calls": true,
  "presence_penalty": -2,
  "previous_response_id": null,
  "prompt_cache_key": "string",
  "reasoning": {
    "effort": "low",
    "summary": "auto",
    "property1": null,
    "property2": null
  },
  "store": false,
  "stream": true,
  "stream_options": {
    "include_obfuscation": true
  },
  "temperature": 2,
  "text": {
    "format": {
      "type": "text"
    },
    "verbosity": "low"
  },
  "tool_choice": "auto",
  "tools": [
    {
      "description": "string",
      "name": "string",
      "parameters": {
        "property1": null,
        "property2": null
      },
      "strict": true,
      "type": "function"
    }
  ],
  "top_p": 1
}'

const response = await fetch("https://api.quiver.ai/v1/responses", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "frequency_penalty": -2,
  "input": "string",
  "instructions": "string",
  "max_output_tokens": 0,
  "max_tool_calls": 0,
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "model": "string",
  "parallel_tool_calls": true,
  "presence_penalty": -2,
  "previous_response_id": null,
  "prompt_cache_key": "string",
  "reasoning": {
    "effort": "low",
    "summary": "auto",
    "property1": null,
    "property2": null
  },
  "store": false,
  "stream": true,
  "stream_options": {
    "include_obfuscation": true
  },
  "temperature": 2,
  "text": {
    "format": {
      "type": "text"
    },
    "verbosity": "low"
  },
  "tool_choice": "auto",
  "tools": [
    {
      "description": "string",
      "name": "string",
      "parameters": {
        "property1": null,
        "property2": null
      },
      "strict": true,
      "type": "function"
    }
  ],
  "top_p": 1
})
});

import requests

response = requests.post(
    "https://api.quiver.ai/v1/responses",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
  "frequency_penalty": -2,
  "input": "string",
  "instructions": "string",
  "max_output_tokens": 0,
  "max_tool_calls": 0,
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "model": "string",
  "parallel_tool_calls": True,
  "presence_penalty": -2,
  "previous_response_id": None,
  "prompt_cache_key": "string",
  "reasoning": {
    "effort": "low",
    "summary": "auto",
    "property1": None,
    "property2": None
  },
  "store": False,
  "stream": True,
  "stream_options": {
    "include_obfuscation": True
  },
  "temperature": 2,
  "text": {
    "format": {
      "type": "text"
    },
    "verbosity": "low"
  },
  "tool_choice": "auto",
  "tools": [
    {
      "description": "string",
      "name": "string",
      "parameters": {
        "property1": None,
        "property2": None
      },
      "strict": True,
      "type": "function"
    }
  ],
  "top_p": 1
},
)

Response

{
  "background": false,
  "completed_at": 0,
  "created_at": 0,
  "error": {
    "code": "server_error",
    "message": "string",
    "quiver_code": "invalid_request",
    "reason": "max_tool_calls",
    "status_code": 0,
    "type": "invalid_request_error"
  },
  "frequency_penalty": 0,
  "id": "string",
  "incomplete_details": {
    "code": "invalid_request",
    "message": "string",
    "reason": "content_filter",
    "status_code": 0
  },
  "instructions": "string",
  "max_output_tokens": 0,
  "max_tool_calls": 0,
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "model": "string",
  "object": "response",
  "output": [
    {
      "arguments": "string",
      "call_id": "string",
      "id": "string",
      "name": "string",
      "status": "completed",
      "type": "function_call"
    }
  ],
  "parallel_tool_calls": true,
  "presence_penalty": 0,
  "previous_response_id": "string",
  "prompt_cache_key": "string",
  "reasoning": {
    "effort": "low",
    "summary": "auto",
    "property1": null,
    "property2": null
  },
  "safety_identifier": "string",
  "service_tier": "default",
  "status": "completed",
  "store": true,
  "temperature": 0,
  "text": {
    "format": {
      "type": "text"
    },
    "verbosity": "low"
  },
  "tool_choice": "auto",
  "tools": [
    {
      "description": "string",
      "name": "string",
      "parameters": {
        "property1": null,
        "property2": null
      },
      "strict": true,
      "type": "function"
    }
  ],
  "top_logprobs": 0,
  "top_p": 0,
  "truncation": "disabled",
  "usage": {
    "input_tokens": 0,
    "input_tokens_details": {
      "cache_write_tokens": 0,
      "cached_tokens": 0
    },
    "output_tokens": 0,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 0
  }
}

{
  "code": "invalid_request",
  "message": "Invalid request parameters",
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": 400
}

{
  "code": "unauthorized",
  "message": "Unauthorized",
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": 401
}

{
  "code": "insufficient_credits",
  "message": "Insufficient credits",
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": 402
}

{
  "code": "account_frozen",
  "message": "Account is frozen",
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": 403
}

{
  "code": "model_not_found",
  "message": "Model not found",
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": 404
}

{
  "code": "request_timeout",
  "message": "Request timed out",
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": 408
}

{
  "code": "payload_too_large",
  "message": "Payload too large",
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": 413
}

{
  "code": "rate_limit_exceeded",
  "message": "Rate limit exceeded. Please try again later.",
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": 429
}

{
  "code": "server_error",
  "message": "The request could not be completed. Please retry.",
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": 500
}

{
  "code": "model_error",
  "message": "The request could not be completed. Please retry.",
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": 502
}

{
  "code": "model_unavailable",
  "message": "The request could not be completed. Please retry.",
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": 503
}

{
  "code": "request_timeout",
  "message": "The request could not be completed. Please retry.",
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": 504
}