Skip to main content
POST
/
v3
/
compat
/
openresponses
OpenResponses API
curl --request POST \
  --url https://api.opper.ai/v3/compat/openresponses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "completed_at": 123,
  "created_at": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "param": "<string>"
  },
  "id": "<string>",
  "incomplete_details": "<unknown>",
  "model": "<string>",
  "object": "<string>",
  "output": [
    {
      "type": "<string>",
      "action": "<string>",
      "arguments": "<string>",
      "cache_creation_tokens": 123,
      "cache_read_tokens": 123,
      "call_id": "<string>",
      "content": [
        {
          "text": "<string>",
          "type": "<string>",
          "annotations": [
            "<unknown>"
          ],
          "refusal": "<string>"
        }
      ],
      "cost_usd": 123,
      "encrypted_content": "<string>",
      "execution_ms": 123,
      "findings": [
        "<unknown>"
      ],
      "flagged": true,
      "guard_type": "<string>",
      "id": "<string>",
      "model_warnings": [
        "<string>"
      ],
      "models_used": [
        "<string>"
      ],
      "name": "<string>",
      "role": "<string>",
      "status": "<string>",
      "summary": [
        {
          "text": "<string>",
          "type": "<string>"
        }
      ]
    }
  ],
  "status": "<string>",
  "tool_choice": "<unknown>",
  "frequency_penalty": 123,
  "instructions": "<string>",
  "max_output_tokens": 123,
  "metadata": {},
  "presence_penalty": 123,
  "reasoning": {
    "effort": "<string>",
    "summary": "<string>"
  },
  "service_tier": "<string>",
  "temperature": 123,
  "text": {
    "format": {
      "type": "<string>",
      "name": "<string>",
      "schema": {}
    }
  },
  "tools": [
    {
      "type": "<string>",
      "description": "<string>",
      "name": "<string>",
      "parameters": {},
      "strict": true
    }
  ],
  "top_p": 123,
  "truncation": "<string>",
  "usage": {
    "input_tokens": 123,
    "output_tokens": 123,
    "total_tokens": 123,
    "input_tokens_details": {
      "cached_tokens": 123
    },
    "output_tokens_details": {
      "reasoning_tokens": 123
    }
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication. Pass your API key as a Bearer token.

Headers

​
X-Opper-Name
string

Function name for tracing and routing.

​
X-Opper-Parent-Span-Id
string<uuid>

Parent span ID for distributed tracing context.

​
X-Opper-Guard-Input
string

Comma-separated input guardrail checks (e.g. "pii,secrets").

​
X-Opper-Guard-Output
string

Comma-separated output guardrail checks (e.g. "toxicity").

​
X-Opper-Guard-Action
enum<string>
default:flag

Action for guardrail violations: "flag" (default), "block", or "redact".

Available options:
flag,
block,
redact

Body

application/json
​
frequency_penalty
number
​
include
string[]
​
input
object
​
instructions
string
​
max_output_tokens
integer
​
max_tool_calls
integer
​
metadata
object
​
model
string
​
parallel_tool_calls
boolean
​
presence_penalty
number
​
previous_response_id
string
​
reasoning
object
​
service_tier
string
​
store
boolean
​
stream
boolean
​
temperature
number
​
text
object
​
tool_choice
any

Any value

​
tools
object[]
​
top_p
number
​
truncation
string

Response

Successful response

​
completed_at
integer
required
​
created_at
integer
required
​
error
object
required
​
id
string
required
​
incomplete_details
any
required

Any value

​
model
string
required
​
object
string
required
​
output
object[]
required
​
status
string
required
​
tool_choice
any
required

Any value

​
frequency_penalty
number
​
instructions
string
​
max_output_tokens
integer
​
metadata
object
​
presence_penalty
number
​
reasoning
object
​
service_tier
string
​
temperature
number
​
text
object
​
tools
object[]
​
top_p
number
​
truncation
string
​
usage
object