Skip to main content
POST
/
v3
/
compat
/
embeddings
Embeddings API
curl --request POST \
  --url https://api.opper.ai/v3/compat/embeddings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": "<unknown>",
  "model": "<string>"
}
'
{
  "data": [
    {
      "embedding": [
        123
      ],
      "index": 123,
      "object": "<string>"
    }
  ],
  "model": "<string>",
  "object": "<string>",
  "usage": {
    "prompt_tokens": 123,
    "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
​
input
any
required

Any value

​
model
string
required
​
dimensions
integer
​
encoding_format
string
​
user
string

Response

Successful response

​
data
object[]
required
​
model
string
required
​
object
string
required
​
usage
object
required