Skip to main content
POST
/
v3
/
compat
/
v1beta
/
interactions
Interactions API
curl --request POST \
  --url https://api.opper.ai/v3/compat/v1beta/interactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contents": "<unknown>",
  "input": "<unknown>"
}
'
{
  "id": "<string>",
  "outputs": [
    {
      "type": "<string>",
      "args": {},
      "data": "<string>",
      "id": "<string>",
      "mime_type": "<string>",
      "name": "<string>",
      "summary": "<string>",
      "text": "<string>",
      "thought": "<string>"
    }
  ],
  "status": "<string>",
  "agent": "<string>",
  "error": {
    "code": "<string>",
    "message": "<string>"
  },
  "input": "<unknown>",
  "model": "<string>",
  "previous_interaction_id": "<string>",
  "usage": {
    "total_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
​
contents
any
required

Any value

​
input
any
required

Any value

​
agent
string
​
background
boolean
​
generation_config
object
​
model
string
​
previous_interaction_id
string
​
response_format
object
​
store
boolean
​
stream
boolean
​
system_instruction
string
​
tools
object[]

Response

Successful response

​
id
string
required
​
outputs
object[]
required
​
status
string
required
​
agent
string
​
error
object
​
input
any

Any value

​
model
string
​
previous_interaction_id
string
​
usage
object