Embedding

Converts text into vector representations. Supports batch input, multiple models, and configurable output dimensions.

post/embedding

Request

  • Base URL: https://api.octen.ai
  • URL: https://api.octen.ai/embedding
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Request body

inputstring[] required

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

model'octen-embedding-0.6b' | 'octen-embedding-4b' | 'octen-embedding-8b'

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.

dimensioninteger

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'query' | 'document' nullable

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.

Response

Successful embedding response

codeinteger

Business status code. 0 indicates success.

msgstring

A message describing the result.

request_idstring

The unique identifier for this request.

Changes

No recorded changes to this operation across all 1 revision of this API.