Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer token used for request authentication. Alternatively, you can send the API key in the x-api-key header. Note: A payment method is required to use the API.

Body

application/json
input
string[]
required

The text to be converted into embeddings. Maximum tokens per element: 32768. Maximum request body size: 2MB

Maximum array length: 1000
model
enum<string>
default:octen-embedding-4b

The embedding model used for this request. octen-embedding-0.6b (max dim: 1024) for cost/throughput priority; octen-embedding-4b (max dim: 2560) for most applications; octen-embedding-8b (max dim: 4096) for accuracy-critical tasks.

Available options:
octen-embedding-0.6b,
octen-embedding-4b,
octen-embedding-8b
dimension
integer

The dimensionality of the output embedding vectors. Defaults to the model's max dimension (0.6b: 1024, 4b: 2560, 8b: 4096). If set to a value smaller than the model default, the embedding will be truncated to the first N values. Any positive integer ≤ model default dimension is allowed.

input_type
enum<string> | null

Specifies whether the input is a query or a document for retrieval. Different values apply different internal prompts: query → "Represent the query for retrieving supporting" (prepended and counted in input_tokens); document and null mean no special prompt is applied.

Available options:
query,
document

Response

Successful embedding response

code
integer

Business status code. 0 indicates success.

msg
string

A message describing the result.

request_id
string

The unique identifier for this request.

data
object

The main embedding response payload.

meta
object

Additional metadata for the embedding request.