Create embed

Request

Header Params

Authorization

string

optional

Example:

Bearer {{YOUR_API_KEY}}

Body Params application/json

model

string

required

The ID of the model to use. You can use the List models API to view all available models, or refer to our model overview for their descriptions.

input

string

required

Enter text to get embeddings, encoded as a string or array of tokens. To get embeddings for multiple inputs in a single request, pass an array of strings or an array of token arrays. The length of each input must not exceed 8192 tokens.

Example

{
  "model": "text-embedding-ada-002",
  "input": "The food was delicious and the waiter..."
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/v1/embeddings' \
--header 'Authorization: Bearer {{YOUR_API_KEY}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "model": "text-embedding-ada-002",
  "input": "The food was delicious and the waiter..."
}'

Responses

🟢200Create embeddings

application/json

Body

object

string

required

data

array [object {3}]

required

object

string

optional

embedding

array[number]

optional

index

integer

optional

model

string

required

usage

object

required

prompt_tokens

integer

required

total_tokens

integer

required

Example

{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "embedding": [
        0.0023064255,
        -0.009327292,
        .... (1536 floats total for ada-002)
        -0.0028842222
      ],
      "index": 0
    }
  ],
  "model": "text-embedding-ada-002",
  "usage": {
    "prompt_tokens": 8,
    "total_tokens": 8
  }
}