Skip to main content
POST
/
v1
/
embeddings
Create Embeddings
curl --request POST \
  --url https://api.apiyi.com/v1/embeddings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "text-embedding-ada-002",
  "input": "This is a sample text for embedding."
}
'
{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "index": 0,
      "embedding": [
        0.0023064255,
        -0.009327292,
        0.015797347
      ]
    }
  ],
  "model": "text-embedding-ada-002",
  "usage": {
    "prompt_tokens": 12,
    "total_tokens": 12
  }
}

Authorizations

​
Authorization
string
header
required

API Key obtained from the APIYI Console

Body

application/json
​
model
string
required

Embedding model name

Examples:

"text-embedding-ada-002"

"text-embedding-3-small"

"text-embedding-3-large"

​
input
required

Text to embed. Can be a single string or an array of strings.

Example:

"This is a sample text for embedding."

​
encoding_format
enum<string>
default:float

Encoding format for the returned vectors

Available options:
float,
base64

Response

Successfully returned vector data

​
object
enum<string>
Available options:
list
Example:

"list"

​
data
object[]
​
model
string
Example:

"text-embedding-ada-002"

​
usage
object