# 概要 (/ja/docs/api)

cheapaimodel APIのBase URL、認証、エラー、すべてのエンドポイント。



cheapaimodel APIは、1つのホストでOpenAI互換のエンドポイントとAnthropic Messagesエンドポイントの2つのAPI形式に対応しています。どちらも同じAPIキーと残高を使います。

## Base URL [#base-url]

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

OpenAI形式のクライアントには`https://api.cheapaimodel.ai/v1`を、Anthropic形式のクライアントにはパスを含まないホスト名のみを指定します。SDKやツールごとに指定する値は[Base URL](/ja/docs/api/base-url)を参照してください。

## 認証 [#authentication]

APIキーをBearerトークンとして送信します。`/v1/messages`はAnthropic形式の`x-api-key`ヘッダーも受け付けます。

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

キーはコンソールの[APIキー](https://console.cheapaimodel.ai/keys)ページで作成します。有効期限、利用上限、許可リストについては[認証とAPIキー](/ja/docs/concepts/authentication)を参照してください。

## エンドポイント [#endpoints]

| メソッド   | パス                     |                                                                 |
| ------ | ---------------------- | --------------------------------------------------------------- |
| `GET`  | `/v1/models`           | [List models](/ja/docs/api/list-models)                         |
| `POST` | `/v1/chat/completions` | [Create a chat completion](/ja/docs/api/create-chat-completion) |
| `POST` | `/v1/responses`        | [Create a response](/ja/docs/api/create-response)               |
| `POST` | `/v1/messages`         | [Create a message](/ja/docs/api/create-message)                 |
| `POST` | `/v1/embeddings`       | [Create embeddings](/ja/docs/api/create-embedding)              |

生成系のエンドポイントで`"stream": true`を設定すると、レスポンスをServer-Sent Eventsで受け取れます。[ストリーミング](/ja/docs/concepts/streaming)を参照してください。

## エラー [#errors]

エラーは2xx以外のステータスと、`error.message`を含むJSON本文で返されます。ステータスコードと`error.code`で処理を分岐してください。ステータスコードの一覧は[エラー](/ja/docs/concepts/errors)を参照してください。

## OpenAPI [#openapi]

これらのエンドポイントの機械可読な仕様は[`/docs/openapi.yaml`](/docs/openapi.yaml)にあります。SDKジェネレーターやAIアシスタントに読み込ませて使えます。
