Skip to main content
POST
Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.
Choose an exact compatible ID from the model list. Supported parameters and output formats vary by model and connection; this schema does not guarantee every upstream feature. See endpoint availability.

Authorizations

api-key
string
header
required

Your Hicap API key.

Headers

x-hicap-tags
string

One JSON object mapping dimension keys to short string values. Never include secrets or direct personal identifiers. Opaque identity references require approved policy and verified destination handling; see the identity attribution guide.

Body

application/json
input
default:""
required

Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays. The input must not exceed the max input tokens for the model (8192 tokens for text-embedding-ada-002), cannot be an empty string, and any array must be 2048 dimensions or less.

Example:

"This is a test."

model
string
required

Exact compatible Hicap model ID from GET /v1/models.

Minimum string length: 1
user
string

A unique identifier representing your end-user, which can help monitoring and detecting abuse.

input_type
string

input type of embedding search to use

Example:

"query"

encoding_format
string | null

The format to return the embeddings in. Can be either float or base64. Defaults to float.

Example:

"float"

dimensions
integer | null

The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models.

Example:

1

Response

OK

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