POST /v1/embeddings

Create embeddings for text using OpenAI-compatible and alternative embedding models

Request

  • Base URL
    https://api.nano-gpt.com/api
  • URL
    https://api.nano-gpt.com/api/v1/embeddings
  • Auth
    • HTTP bearer
    • or API key in header x-api-key

Request body

modelstring required

ID of the embedding model to use

encoding_format'float' | 'base64'

Format for embeddings

dimensionsinteger

Reduce embedding dimensions (only for supported models)

userstring

Optional identifier for tracking usage

Example request

{
  "model": "text-embedding-3-small",
  "dimensions": 256
}

Response

Embedding response

objectstring required

Always 'list' for embeddings

modelstring required

Model used for embeddings

Example response

{
  "object": "list",
  "data": [
    {
      "object": "embedding"
    }
  ],
  "model": "text-embedding-3-small",
  "usage": {
    "prompt_tokens": 8,
    "total_tokens": 8
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.