VL Embedding

Converts multimodal input (text, images, and videos) into vector representations. Supports a single fused vector across modalities, independent per-element vectors, configurable output dimensions, video frame sampling control, and a custom task instruction.

post/vl-embedding

Request

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

Request body

model'octen-vl-embedding' | 'octen-vl-embedding-large' required

The multimodal embedding model used for this request.

enable_fusionboolean

Whether to generate a fused embedding. When true, all elements in contents are fused into a single vector; when false, each element produces an independent vector.

dimensioninteger

The dimensionality of the output embedding vectors. Defaults to the model's max dimension (octen-vl-embedding: 2048, octen-vl-embedding-large: 4096). Any positive integer ≤ the model's max dimension is allowed.

fpsnumber

Frames sampled per second of video. For example, 0.5 samples one frame every two seconds. Lower values sample fewer frames and reduce video token consumption. Each video is sampled to at most 64 frames.

instructstring

Custom task description used to guide the model in understanding the query intent. Its length counts toward input_tokens and shares the 10,000-character total limit with contents.

Response

Successful VL 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.