Create embeddings

POST /embeddings

Creates an embedding vector representing the input text.

application/json

Body Required

  • input string | array[string] | array[integer] | array[array] Required

    One of:
    string string array array[string] array array[integer] array array[array]

    The string that will be turned into an embedding.

    Default value is empty.

    The array of strings that will be turned into an embedding.

    At least 1 but not more than 2048 elements. Default value is empty.

    The array of integers that will be turned into an embedding.

    At least 1 but not more than 2048 elements.

    The array of arrays containing integers that will be turned into an embedding.

    At least 1 but not more than 2048 elements.

    At least 1 element.

  • model string Required

    Any of:
    string-1 string string-2 string

    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.

    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.

    Values are text-embedding-ada-002, text-embedding-3-small, or text-embedding-3-large.

  • encoding_format string

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

    Values are float or base64. Default value is float.

  • dimensions integer

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

    Minimum value is 1.

  • user string

    A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.

  • Additional properties are NOT allowed

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • data array[object] Required

      Represents an embedding vector returned by embedding endpoint.

      Hide data attributes Show data attributes object
      • index integer Required

        The index of the embedding in the list of embeddings.

      • embedding array[number] Required

        The embedding vector, which is a list of floats. The length of vector depends on the model as listed in the embedding guide.

      • object string Required

        The object type, which is always "embedding".

        Value is embedding.

    • model string Required

      The name of the model used to generate the embedding.

    • object string Required

      The object type, which is always "list".

      Value is list.

    • usage object Required

      The usage information for the request.

      Hide usage attributes Show usage attributes object
      • prompt_tokens integer Required

        The number of tokens used by the prompt.

      • total_tokens integer Required

        The total number of tokens used by the request.
POST /embeddings 
curl \
 -X POST https://api.openai.com/v1/embeddings \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"input":"This is a test.","model":"text-embedding-3-small","encoding_format":"float","dimensions":42,"user":"user-1234"}'
Request example 
{
  "input": "This is a test.",
  "model": "text-embedding-3-small",
  "encoding_format": "float",
  "dimensions": 42,
  "user": "user-1234"
}
Response examples (200) 
{
  "data": [
    {
      "index": 42,
      "embedding": [
        42.0
      ],
      "object": "embedding"
    }
  ],
  "model": "string",
  "object": "list",
  "usage": {
    "prompt_tokens": 42,
    "total_tokens": 42
  }
}