API Reference
Log In
API Reference

Embeds texts as vectors.

Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms. Note that the vectors are NOT normalized.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
required

Input text to embed, encoded as a string or array of strings (to embed multiple inputs in a single request). The input must not exceed the max input tokens for the model, and cannot contain empty string.

string
required

The ID of the model to use. You can use the List models API to see all of your available models.

string
enum
Defaults to document

Whether the input text is a "query" (used to retrieve) or a "document" (to be retrieved).

Allowed:
string
enum
Defaults to float

Optional. The format to return the embeddings in. Can be either "float" or "base64". base64 string should be decoded as a float32 array. Example: np.frombuffer(base64.b64decode(response), dtype=np.float32)

Allowed:
Headers
string
required

User PAT or service key.

string

User ID. Can be omitted if PAT is used as token.

string

Project ID. Can be omitted if PAT is used as token.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json