# 總覽 (/zh-Hant/docs/api)

cheapaimodel API 的 Base URL、驗證、錯誤與所有端點。



cheapaimodel API 在同一個主機上提供兩種協定：OpenAI 相容端點與 Anthropic Messages 端點。兩者使用相同的 API Key 與同一份餘額。

## Base URL [#base-url]

```text
https://api.cheapaimodel.ai
```

OpenAI 風格的用戶端使用 `https://api.cheapaimodel.ai/v1`；Anthropic 風格的用戶端使用不含路徑的主機。各 SDK 與工具需要的值請參閱 [Base URL](/zh-Hant/docs/api/base-url)。

## 驗證 [#authentication]

以 bearer token 傳送你的 API Key。`/v1/messages` 另外也接受 Anthropic 風格的 `x-api-key` 標頭。

```bash
curl https://api.cheapaimodel.ai/v1/models \
  -H "Authorization: Bearer $CHEAPAIMODEL_API_KEY"
```

請在控制台的 [API Key](https://console.cheapaimodel.ai/keys) 頁面建立 Key。到期、預算與允許清單請參閱[驗證與 API Key](/zh-Hant/docs/concepts/authentication)。

## 端點 [#endpoints]

| 方法     | 路徑                     |                                                                |
| ------ | ---------------------- | -------------------------------------------------------------- |
| `GET`  | `/v1/models`           | [列出模型](/zh-Hant/docs/api/list-models)                          |
| `POST` | `/v1/chat/completions` | [建立 chat completion](/zh-Hant/docs/api/create-chat-completion) |
| `POST` | `/v1/responses`        | [建立 response](/zh-Hant/docs/api/create-response)               |
| `POST` | `/v1/messages`         | [建立 message](/zh-Hant/docs/api/create-message)                 |
| `POST` | `/v1/embeddings`       | [建立 embeddings](/zh-Hant/docs/api/create-embedding)            |

在生成類端點設定 `"stream": true` 即可接收 server-sent events；請參閱[串流](/zh-Hant/docs/concepts/streaming)。

## 錯誤 [#errors]

錯誤會回傳非 2xx 狀態碼，以及帶有 `error.message` 的 JSON 主體。請依狀態碼與 `error.code` 分支處理；完整對照表請參閱[錯誤](/zh-Hant/docs/concepts/errors)。

## OpenAPI [#openapi]

這些端點的機器可讀契約位於 [`/docs/openapi.yaml`](/docs/openapi.yaml)。可以交給 SDK 產生器或 AI 助理使用。