---
title: "OpenAI compatible route"
method: POST
path: "/openai"
tags: ["Text Embeddings Inference"]
---

# OpenAI compatible route

`POST /openai`

OpenAI compatible route

## Request body

- OpenAICompatRequest
  - `input` union, required
    - string
    - string[]
  - `model` string, nullable
  - `user` string, nullable

## Response `200`

Embeddings

- OpenAICompatResponse
  - `data` OpenAICompatEmbedding[], required
    - `embedding` number[], required
    - `index` integer, required
    - `object` string, required
  - `model` string, required
  - `object` string, required
  - `usage` OpenAICompatUsage, required
    - `prompt_tokens` integer, required
    - `total_tokens` integer, required

## Other responses

- `413` — Batch size error
- `422` — Tokenization error
- `424` — Embedding Error
- `429` — Model is overloaded

## Changes

- **2023-10-13** `8c00768ef703` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/huggingface/apis/text-embeddings-inference/changes/openai/post.md)

---

[API](https://skmtc.dev/huggingface/apis/text-embeddings-inference.md) · [All operations](https://skmtc.dev/huggingface/apis/text-embeddings-inference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/huggingface/text-embeddings-inference/revisions/42caec51b2df/schema)