Skip to content
mistral.rs

Get response by ID endpoint

GET
/v1/responses/{response_id}
 
curl --request GET \
  --url https://example.com/v1/responses/example

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
response_id
required
string

The ID of the response to retrieve

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Response object

Media type application/json

The main response resource returned by the OpenResponses API

object
adapter_generation

Exact LoRA generation used for this response.

string | null
background

Whether request runs in background

boolean | null
completed_at

Unix timestamp when the response was completed (if completed)

integer | null format: int64
created_at
required

Unix timestamp when the response was created

integer format: int64
error
One of:
null
frequency_penalty

Frequency penalty from the request

number | null format: float
id
required

Unique identifier for this response

string
incomplete_details
One of:
null
instructions

System instructions (if provided)

string | null
max_output_tokens

Max output tokens from the request

integer | null
max_tool_calls

Max tool calls from the request (even if unsupported)

integer | null
metadata

User-provided metadata

model
required

The model used for this response

string
object
required

Object type (always “response”)

string
output
required

Output items generated by the model

Array
One of:
object
content
required
Array
One of:
object
text
required
string
type
required
string
Allowed values: output_text
id
required
string
role
required
string
status
required
string
type
required
string
Allowed values: message
output_text

Concatenated text from all text output content

string | null
parallel_tool_calls

Whether parallel tool calls are enabled

boolean | null
presence_penalty

Presence penalty from the request

number | null format: float
previous_response_id

Previous response ID (for multi-turn conversations)

string | null
reasoning

Reasoning/chain-of-thought content from the model

string | null
status
required

Current status of the response

string
Allowed values: queued in_progress completed failed incomplete cancelled
store

Whether to store the response

boolean | null
temperature

Temperature from the request

number | null format: double
text
One of:
null
tool_choice
One of:
null
tools

Tool definitions from the request

Array | null
One of:

Tool definition

object
function
required

Function definition for a tool

object
description
string | null
name
required
string
parameters
object | null
strict

When true, the tool’s parameters JSON schema is enforced on the generated arguments via constrained decoding (llguidance).

boolean | null
type
required

Type of tool

string
Allowed values: function
top_logprobs

Top logprobs from the request

integer | null
top_p

Top-p from the request

number | null format: double
truncation
One of:
null
usage
One of:
null
Example 
{
  "incomplete_details": {
    "reason": "max_output_tokens"
  },
  "output": [
    {
      "content": [
        {
          "type": "output_text"
        }
      ],
      "type": "message"
    }
  ],
  "status": "queued",
  "text": {
    "format": {
      "type": "text"
    }
  },
  "tool_choice": "none",
  "tools": [
    {
      "type": "function"
    }
  ],
  "truncation": "auto"
}