4e064cf81dae

latestOpenAPI 3.1.02026-08-131831,331960.0 KB

multimodal

Create embeddings

Create embeddings through the Respan gateway with automatic logging.

post/api/embeddings

Headers

Authorizationstring required

Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan_params.credential_override in the request body, not in this authentication field.

X-Data-Respan-Paramsstring

Base64-encoded JSON object of Respan parameters. Legacy X-Data-Keywordsai-Params is still accepted.

Request body

model'text-embedding-3-small' | 'text-embedding-3-large' | 'text-embedding-ada-002' required

Embedding model ID.

{"stackTrail":"paths:/api/embeddings:post:requestBody:content:application/json:schema:properties:input","oasType":"schema","type":"unknown","description":"Text to embed. String or array of strings."}

encoding_format'float' | 'base64'

Output format.

dimensionsinteger

Output embedding dimensions. Only supported by text-embedding-3-* models.

customer_credentialsApiEmbeddingsPostRequestBodyContentApplicationJsonSchemaCustomerCredentials

Per-customer LLM provider credentials.

disable_logboolean

When true, omits input/output from the log. Metrics still recorded.

metadataApiEmbeddingsPostRequestBodyContentApplicationJsonSchemaMetadata

Custom key-value metadata.

customer_identifierstring

End user identifier.

thread_identifierstring

Conversation thread ID.

Response

Embedding results.

objectstring

modelstring