Body
Required
input
string | array[string] | array[integer] | array[array] 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 Python code for counting tokens. Some models may also impose a limit on total number of tokens summed across inputs.model
string Required ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.
-
The format to return the embeddings in. Can be either
float
orbase64
.Values are
float
orbase64
. Default value isfloat
. -
The number of dimensions the resulting output embeddings should have. Only supported in
text-embedding-3
and later models.Minimum value is
1
. -
A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.
curl \
--request POST 'https://api.openai.com/v1/embeddings' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"input":"This is a test.","model":"text-embedding-3-small","encoding_format":"float","dimensions":42,"user":"user-1234"}'
{
"input": "This is a test.",
"model": "text-embedding-3-small",
"encoding_format": "float",
"dimensions": 42,
"user": "user-1234"
}
{
"data": [
{
"index": 42,
"embedding": [
42.0
],
"object": "embedding"
}
],
"model": "string",
"object": "list",
"usage": {
"prompt_tokens": 42,
"total_tokens": 42
}
}