Skip to main content
POST
Responses

Authorizations

Authorization
string
header
required

Authorization: Bearer (OpenAI SDK, Codex, OpenCode, etc.)

Headers

X-Mdlx-Session-Id
string

Optional session affinity header. Length 8–128; alphanumeric, -, and _ only.

Required string length: 8 - 128
Pattern: ^[A-Za-z0-9_-]+$
Example:

"my-conversation-001"

X-Mdlx-User-Id
string

Optional end-user id for filtering request logs later. Length 8–128; ASCII letters, digits, -, and _ only. Invalid values return 400.

Required string length: 8 - 128
Pattern: ^[A-Za-z0-9_-]+$
Example:

"end_user_01"

Body

application/json

OpenAI Responses request body. Requires model and input; optional stream, max_output_tokens, temperature, reasoning, and text. Do not send Chat Completions messages.

Core fields below; other fields follow OpenAI Responses.

model
string
required

Model ID in provider/name form

Examples:

"openai/gpt-5.5"

"openai/gpt-5.6-sol"

"anthropic/claude-sonnet-5"

"google/gemini-3.6-flash"

input
required

String or array of input items. Not a Chat Completions messages array. Image: input_image.image_url (string; HTTPS or data: URL). File: input_file.file_url for HTTPS, file_data for inline bytes. Content types are input_text, input_image, and input_file.

stream
boolean
default:false

Default false. When true, returns an OpenAI Responses SSE event stream.

max_output_tokens
integer

Optional maximum output tokens for the Responses API. Not max_tokens.

Required range: x >= 1
temperature
number

Sampling temperature for the Responses API. Model-dependent.

reasoning
object

Optional reasoning controls. Follows OpenAI Responses (effort, optional mode). Support and allowed values depend on the model.

text
object

Optional text output config. Follows OpenAI Responses. The output format is text.format. Support depends on the model.

Response

Success. Non-streaming returns JSON; streaming returns SSE.

Shape follows OpenAI response

id
string

Unique identifier for this Responses API result.

object
string

Object type. Typically response for the Responses API.

Example:

"response"

status
string

Status of the response (for example completed or failed).

model
string

Model ID that produced this Responses API result.

output
object[]

Array of response output items (OpenAI Responses shape).

usage
object

Token usage object for the Responses API. Shape follows OpenAI Responses usage, not Chat Completions prompt_tokens fields.