QUquiver
OpenResponses

Create OpenResponse

Changed on

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 tools are returned as function_call output items for the caller to execute and replay. Custom tools and custom_tool_call output items are QuiverAI extensions to Open Responses. Streamed error events use the API-authored public error code, message, status_code, request_id, nullable param and optional retry_after, and quiver_error type. Streaming ends with the literal [DONE] transport sentinel.

post/v1/responses

Request

  • Base URL
    https://api.quiver.ai
  • Auth
    HTTP bearer

Headers

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.

Example:trace_01J9AZ3XJ7D5S9ZV2Q5Z8E1A4N

Request body

backgroundfalse

The endpoint answers inline and never queues a background response, so background may only be false. Omitting it means the same thing. Unlike the upstream contract this is not nullable, because a response resource types background as false and a null echoed back would fail response validation.

frequency_penaltynumber nullable
includestring[] nullable

The endpoint returns no additional response content, so include may only be the empty array or null. Omitting it means the same thing. reasoning.encrypted_content is refused because encrypted reasoning is not part of the public contract.

instructionsstring nullable
max_output_tokensinteger nullable
max_tool_callsinteger nullable
metadataobject nullable
modelstring required
parallel_tool_callsboolean nullable
presence_penaltynumber nullable

Responses sampling control. Arrow 2 and Telos accept omission or the default value 0; non-default values are rejected on the current public deployment. Native SVG sampling has separate rules.

previous_response_idunknown
prompt_cache_keystring nullable
safety_identifierstring nullable
service_tier'default' | 'fast'
storefalse

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

streamboolean
temperaturenumber nullable

Responses sampling control. Arrow 2 and Telos accept omission or the default value 1; non-default values are rejected on the current public deployment. Native SVG sampling has separate rules.

top_logprobsinteger nullable
top_pnumber nullable

Responses sampling control. Arrow 2 and Telos accept omission or the default value 1; non-default values are rejected on the current public deployment. Native SVG sampling has separate rules.

truncation'auto' | 'disabled' | 'null' nullable

Response

OpenResponses-compatible ResponseResource returned by the upstream inference service.

backgroundfalse required
completed_atinteger nullable required
created_atinteger required
frequency_penaltynumber required
idstring required
instructionsstring nullable required
max_output_tokensinteger nullable required
max_tool_callsinteger nullable required
metadataobject required
modelstring required
object'response' required
parallel_tool_callsboolean required
presence_penaltynumber required
previous_response_idstring nullable required

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

prompt_cache_keystring nullable required
safety_identifierstring nullable required
service_tier'default' | 'fast' required
status'completed' | 'incomplete' | 'failed' required
storeboolean required

The endpoint is stateless and never persists a response.

temperaturenumber required
top_logprobsinteger required
top_pnumber required
truncation'auto' | 'disabled' required

Changes

  • 5db9b140be5cRevision changes
    • info

      added the new optional request property ////

    • info

      added the optional property /// to the response with the status

  • 7733c6a9d212Revision changes
    • breaking

      the request property became not nullable

    • breaking

      removed the enum value auto of the request property

    • breaking

      removed the enum value flex of the request property

    • breaking

      removed the enum value priority of the request property

    • breaking

      removed the enum value undefined of the request property

    • warning

      added the new fast enum value to the response property for the response status

    • info

      added the new optional request property ////

    • info

      added the new fast enum value to the request property

    • info

      added the optional property /// to the response with the status

    • info

      removed the auto enum value from the response property for the response status

    • info

      removed the flex enum value from the response property for the response status

    • info

      removed the priority enum value from the response property for the response status