ORorq-ai
Responses

Retrieve response

Changed on

Retrieves a previously created response by its ID.

get/v3/router/responses/{response_id}

Request

  • Base URL
    https://my.orq.ai
  • URL
    https://my.orq.ai/v3/router/responses/{response_id}
  • Auth
    HTTP bearer

Path parameters

response_idstring required

The ID of the response to retrieve

Response

Response retrieved successfully.

backgroundboolean required
completed_atinteger nullable required
created_atinteger required
frequency_penaltynumber double required
idstring required
instructionsstring nullable required
max_output_tokensinteger nullable required
max_tool_callsinteger nullable required
metadataobject required

Developer-defined key-value pairs attached to the response (OpenAI spec: Map<string, string>).

modelstring required
objectstring required

Always "response"

parallel_tool_callsboolean required
presence_penaltynumber double required
previous_response_idstring nullable required
prompt_cache_keystring nullable required
prompt_cache_retentionstring nullable required
safety_identifierstring nullable required
service_tier'auto' | 'default' | 'flex' | 'fast' | 'ultrafast' | 'scale' | 'priority' required
status'queued' | 'in_progress' | 'completed' | 'failed' | 'incomplete' required
storeboolean required
temperaturenumber double required
textunknown required
tool_choiceunknown required
top_kinteger

Only sample from the top K options for each subsequent token. Present only when set on the request.

top_logprobsinteger required
top_pnumber double required
truncation'disabled' | 'auto' required
userstring nullable required
variablesobject

Changes

  • 0b4e519a544fRevision changes
    • warning

      added the new 12h enum value to the ///// response property for the response status

    • warning

      added the new instant enum value to the ///// response property for the response status

    • info

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

    • info

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

  • 732aed62833aRevision changes
    • warning

      removed the optional property ////// from the response with the status

    • info

      removed the 12h enum value from the ///// response property for the response status

    • info

      removed the instant enum value from the ///// response property for the response status