API ReferenceapiaiPOST /v1/embeddings

POST /v1/embeddings

Service: ai · operationId: (none)

Required scopes

(no scope declared — review service config)

Request body

{
  "type": "object",
  "properties": {
    "input": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ]
    },
    "model": {
      "type": "string",
      "enum": [
        "text-embedding-3-small",
        "text-embedding-3-large",
        "text-embedding-ada-002"
      ],
      "default": "text-embedding-3-small"
    },
    "brand_id": {
      "type": "string",
      "minLength": 1
    },
    "document_id": {
      "type": "string"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {},
      "default": {}
    }
  },
  "required": [
    "input",
    "brand_id"
  ]
}

Responses

200 Embeddings created

{
  "type": "object",
  "properties": {
    "embeddings": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "index": {
            "type": "number"
          },
          "content": {
            "type": "string"
          },
          "model": {
            "type": "string"
          },
          "token_count": {
            "type": "number"
          }
        },
        "required": [
          "id",
          "index",
          "content",
          "model",
          "token_count"
        ]
      }
    },
    "model": {
      "type": "string"
    },
    "total_tokens": {
      "type": "number"
    }
  },
  "required": [
    "embeddings",
    "model",
    "total_tokens"
  ]
}

400 Invalid input

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "message"
  ]
}

500 Provider error

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "message"
  ]
}

Example

curl -X POST https://ai.platform.loop.health/v1/embeddings \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'