Create a stateless OpenAI Responses-compatible response

POST

responses

curl --request POST \
  --url https://api.example.com/v1/responses \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "<string>",
  "input": "<string>",
  "instructions": "<string>",
  "stream": false,
  "store": true,
  "background": true,
  "previous_response_id": "<string>",
  "max_output_tokens": 499995,
  "max_tool_calls": 64,
  "temperature": 1,
  "top_p": 0.5,
  "presence_penalty": 0,
  "frequency_penalty": 0,
  "tools": [
    {}
  ],
  "parallel_tool_calls": true,
  "reasoning": {
    "enabled": true,
    "max_tokens": 499995,
    "exclude": true
  },
  "include_reasoning": true,
  "text": {
    "format": {
      "type": "<string>"
    }
  },
  "include": [],
  "metadata": {},
  "client_metadata": {},
  "prompt_cache_key": "<string>",
  "user": "<string>",
  "safety_identifier": "<string>",
  "flagged_categories": []
}
'

import requests

url = "https://api.example.com/v1/responses"

payload = {
    "model": "<string>",
    "input": "<string>",
    "instructions": "<string>",
    "stream": False,
    "store": True,
    "background": True,
    "previous_response_id": "<string>",
    "max_output_tokens": 499995,
    "max_tool_calls": 64,
    "temperature": 1,
    "top_p": 0.5,
    "presence_penalty": 0,
    "frequency_penalty": 0,
    "tools": [{}],
    "parallel_tool_calls": True,
    "reasoning": {
        "enabled": True,
        "max_tokens": 499995,
        "exclude": True
    },
    "include_reasoning": True,
    "text": { "format": { "type": "<string>" } },
    "include": [],
    "metadata": {},
    "client_metadata": {},
    "prompt_cache_key": "<string>",
    "user": "<string>",
    "safety_identifier": "<string>",
    "flagged_categories": []
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    model: '<string>',
    input: '<string>',
    instructions: '<string>',
    stream: false,
    store: true,
    background: true,
    previous_response_id: '<string>',
    max_output_tokens: 499995,
    max_tool_calls: 64,
    temperature: 1,
    top_p: 0.5,
    presence_penalty: 0,
    frequency_penalty: 0,
    tools: [{}],
    parallel_tool_calls: true,
    reasoning: {enabled: true, max_tokens: 499995, exclude: true},
    include_reasoning: true,
    text: {format: {type: '<string>'}},
    include: [],
    metadata: {},
    client_metadata: {},
    prompt_cache_key: '<string>',
    user: '<string>',
    safety_identifier: '<string>',
    flagged_categories: []
  })
};

fetch('https://api.example.com/v1/responses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "<string>",
  "model": "<string>",
  "output": [
    {}
  ],
  "object": "response",
  "usage": {
    "input_tokens": 1,
    "output_tokens": 1,
    "total_tokens": 1,
    "input_tokens_details": {},
    "output_tokens_details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

Headers

Authorization

string | null

Bearer API key.

x-api-key

string | null

API key alternative for Anthropic-compatible clients. Authorization takes precedence when both headers are present.

Body

application/json

OpenAI Responses-compatible request.

model

string

required

Public model ID.

Minimum string length: 1

input

required

instructions

string | null

stream

boolean

default:false

store

boolean | null

background

boolean | null

previous_response_id

string | null

max_output_tokens

integer | null

Required range: 1 <= x <= 999990

max_tool_calls

integer | null

Required range: 1 <= x <= 128

temperature

number | null

Required range: 0 <= x <= 2

top_p

number | null

Required range: 0 <= x <= 1

presence_penalty

number | null

Required range: -2 <= x <= 2

frequency_penalty

number | null

Required range: -2 <= x <= 2

tools

Tools · object[]

tool_choice

Available options:

none,

auto,

required

parallel_tool_calls

boolean | null

reasoning

ResponsesReasoning · object | null

Native reasoning.effort plus the reviewed compatibility aliases.

The accepted profile decision requires Responses to take enablement, budget, and visibility aliases, not effort alone, so an OpenRouter- or Codex-shaped client resolves the same intent here that it already resolves on Chat Completions and Messages. max_tokens is the budget alias; the total output cap remains max_output_tokens.

Show child attributes

include_reasoning

boolean | null

text

ResponsesTextConfig · object | null

Show child attributes

include

enum<string>[] | null

Available options:

message.input_image.image_url,

message.output_text.logprobs,

reasoning.encrypted_content

truncation

enum<string> | null

Available options:

auto,

disabled

metadata

Metadata · object | null

Show child attributes

client_metadata

Client Metadata · object | null

prompt_cache_key

string | null

service_tier

enum<string> | null

Available options:

auto,

default,

flex,

scale,

priority

user

string | null

Maximum string length: 512

safety_identifier

string | null

Maximum string length: 64

flagged_categories

enum<string>[]

Available options:

harassment,

harassment/threatening,

hate,

hate/threatening,

illicit,

illicit/violent,

self-harm,

self-harm/intent,

self-harm/instructions,

sexual,

sexual/minors,

violence,

violence/graphic

Response

Successful Response

Native response object with required billing/public identity fields.

string

required

Pattern: ^resp_

status

enum<string>

required

Available options:

completed,

failed,

in_progress,

incomplete,

queued

model

string

required

output

Output · object[]

required

object

string

default:response

Allowed value: "response"

usage

ResponseUsage · object | null

Show child attributes

Last modified on August 11, 2026

Create a stateless OpenAI Responses-compatible response

curl --request POST \
  --url https://api.example.com/v1/responses \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "<string>",
  "input": "<string>",
  "instructions": "<string>",
  "stream": false,
  "store": true,
  "background": true,
  "previous_response_id": "<string>",
  "max_output_tokens": 499995,
  "max_tool_calls": 64,
  "temperature": 1,
  "top_p": 0.5,
  "presence_penalty": 0,
  "frequency_penalty": 0,
  "tools": [
    {}
  ],
  "parallel_tool_calls": true,
  "reasoning": {
    "enabled": true,
    "max_tokens": 499995,
    "exclude": true
  },
  "include_reasoning": true,
  "text": {
    "format": {
      "type": "<string>"
    }
  },
  "include": [],
  "metadata": {},
  "client_metadata": {},
  "prompt_cache_key": "<string>",
  "user": "<string>",
  "safety_identifier": "<string>",
  "flagged_categories": []
}
'

import requests

url = "https://api.example.com/v1/responses"

payload = {
    "model": "<string>",
    "input": "<string>",
    "instructions": "<string>",
    "stream": False,
    "store": True,
    "background": True,
    "previous_response_id": "<string>",
    "max_output_tokens": 499995,
    "max_tool_calls": 64,
    "temperature": 1,
    "top_p": 0.5,
    "presence_penalty": 0,
    "frequency_penalty": 0,
    "tools": [{}],
    "parallel_tool_calls": True,
    "reasoning": {
        "enabled": True,
        "max_tokens": 499995,
        "exclude": True
    },
    "include_reasoning": True,
    "text": { "format": { "type": "<string>" } },
    "include": [],
    "metadata": {},
    "client_metadata": {},
    "prompt_cache_key": "<string>",
    "user": "<string>",
    "safety_identifier": "<string>",
    "flagged_categories": []
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    model: '<string>',
    input: '<string>',
    instructions: '<string>',
    stream: false,
    store: true,
    background: true,
    previous_response_id: '<string>',
    max_output_tokens: 499995,
    max_tool_calls: 64,
    temperature: 1,
    top_p: 0.5,
    presence_penalty: 0,
    frequency_penalty: 0,
    tools: [{}],
    parallel_tool_calls: true,
    reasoning: {enabled: true, max_tokens: 499995, exclude: true},
    include_reasoning: true,
    text: {format: {type: '<string>'}},
    include: [],
    metadata: {},
    client_metadata: {},
    prompt_cache_key: '<string>',
    user: '<string>',
    safety_identifier: '<string>',
    flagged_categories: []
  })
};

fetch('https://api.example.com/v1/responses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "<string>",
  "model": "<string>",
  "output": [
    {}
  ],
  "object": "response",
  "usage": {
    "input_tokens": 1,
    "output_tokens": 1,
    "total_tokens": 1,
    "input_tokens_details": {},
    "output_tokens_details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>"
  }
}