> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bettertoken.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# OpenAI Chat Completions API

> Use BetterToken's OpenAI-compatible Chat Completions API with a complete request URL, Bearer API Key, curl, Python, and JavaScript examples.

Call OpenAI-compatible Chat Completions with `POST https://www.bettertoken.ai/v1/chat/completions`. Most external tools take the Base URL `https://www.bettertoken.ai/v1` and append `/chat/completions` themselves.

## Key settings

| Field            | Value                                            |
| ---------------- | ------------------------------------------------ |
| API Key          | BetterToken API Key                              |
| Full request URL | `https://www.bettertoken.ai/v1/chat/completions` |
| Model            | `YOUR_MODEL_ID`                                  |

## Prerequisites

* <a href={"https://bettertoken.ai/register"}>Create a BetterToken API Key</a>
* Copy a Model ID from the <a href={"https://bettertoken.ai/pricing"}>model plaza</a> or the key **Setup** dialog
* Prepare a terminal with `curl`, or Python 3 / Node.js

## Install

<Tabs>
  <Tab title="curl">
    `curl` needs no SDK. Confirm that `curl --version` works in your terminal.
  </Tab>

  <Tab title="Python">
    ```bash theme={null}
    python -m pip install openai
    ```
  </Tab>

  <Tab title="JavaScript">
    ```bash theme={null}
    npm install openai
    ```
  </Tab>
</Tabs>

## Manual setup

### curl

```bash theme={null}
curl "https://www.bettertoken.ai/v1/chat/completions" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
    "model": "YOUR_MODEL_ID",
    "messages": [
      {
        "role": "user",
        "content": "Hello"
      }
    ]
  }'
```

### Python SDK

```python theme={null}
from openai import OpenAI

client = OpenAI(
    api_key="YOUR_API_KEY",
    base_url="https://www.bettertoken.ai/v1",
)

response = client.chat.completions.create(
    model="YOUR_MODEL_ID",
    messages=[
        {"role": "user", "content": "Hello"},
    ],
)

print(response.choices[0].message.content)
```

### JavaScript SDK

```javascript theme={null}
import OpenAI from "openai";

const client = new OpenAI({
  apiKey: "YOUR_API_KEY",
  baseURL: "https://www.bettertoken.ai/v1",
});

const response = await client.chat.completions.create({
  model: "YOUR_MODEL_ID",
  messages: [{ role: "user", content: "Hello" }],
});

console.log(response.choices[0].message.content);
```

## Verify the connection

In the Playground on the right:

1. Enter `YOUR_API_KEY` under **Authorization**.
2. Replace `model` with `YOUR_MODEL_ID`.
3. Edit `messages` and send the request.

The Playground already uses the complete URL `https://www.bettertoken.ai/v1/chat/completions`.

A `200` response with model output in `choices[0].message.content` confirms the connection.

## Switch models

Replace `YOUR_MODEL_ID` with the complete Model ID from the model plaza or **Setup** dialog. Do not shorten the Model ID based on its display name.

## Common errors

| Error           | Fix                                                                                                                          |
| --------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `401`           | Confirm `Authorization: Bearer YOUR_API_KEY`, then copy the BetterToken API Key again.                                       |
| `404`           | Direct HTTP calls use `https://www.bettertoken.ai/v1/chat/completions`; SDK `base_url` uses `https://www.bettertoken.ai/v1`. |
| Model not found | Use the complete Model ID from the model plaza or **Setup** dialog.                                                          |
| Invalid request | Confirm that `messages` is an array and every item has `role` and `content`.                                                 |

## Advanced setup

### Supported providers

| Provider | Status        |
| -------- | ------------- |
| Claude   | Not supported |
| GPT      | Manual setup  |
| Kimi     | Manual setup  |
| GLM      | Manual setup  |

<Note>Statuses apply to the BetterToken setup documented on this page.</Note>

<Accordion title="What the setup methods mean">
  * **Manual setup**: enter the API Key, Base URL, and Model.
  * **Not supported**: no verified direct setup is currently available.
</Accordion>

## Technical details

<Accordion title="Base URL and full request URL">
  Tools that require a complete request URL, such as GitHub Copilot and TRAE, use `https://www.bettertoken.ai/v1/chat/completions`. Tools that append the path themselves, such as Cursor, Cline, OpenCode, n8n, and Dify, use only `https://www.bettertoken.ai/v1`.
</Accordion>


## OpenAPI

````yaml api-reference/openapi.json POST /v1/chat/completions
openapi: 3.1.0
info:
  title: BetterToken GPT Image 2 API
  description: >-
    OpenAI-compatible image generation and image editing endpoints for
    BetterToken.
  version: 1.0.0
servers:
  - url: https://www.bettertoken.ai
security:
  - bearerAuth: []
paths:
  /v1/chat/completions:
    post:
      tags:
        - OpenAI Chat Completions
      summary: 创建 Chat Completions 响应
      description: >-
        通过 BetterToken 的 OpenAI-compatible Chat Completions API 向 GPT
        提供商模型发送对话消息。适用于需要 /v1/chat/completions 的外部工具和应用。
      operationId: createChatCompletion
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChatCompletionsRequest'
            example:
              model: YOUR_MODEL_ID
              messages:
                - role: user
                  content: Hello
      responses:
        '200':
          $ref: '#/components/responses/ChatCompletionResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
        - lang: cURL
          label: cURL
          source: |-
            curl 'https://www.bettertoken.ai/v1/chat/completions' \
              -H 'Authorization: Bearer YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              --data '{
                "model": "YOUR_MODEL_ID",
                "messages": [{"role": "user", "content": "Hello"}]
              }'
components:
  schemas:
    ChatCompletionsRequest:
      type: object
      required:
        - model
        - messages
      properties:
        model:
          type: string
          description: GPT 提供商中可用的模型 ID。请以模型广场当前显示的模型为准。
          example: YOUR_MODEL_ID
        messages:
          type: array
          minItems: 1
          description: 对话消息数组。每项应包含 role 和 content。
          items:
            type: object
            required:
              - role
              - content
            properties:
              role:
                type: string
                example: user
              content:
                type: string
                example: Hello
            additionalProperties: true
        stream:
          type: boolean
          description: 是否请求流式响应。
          default: false
      additionalProperties: true
    ChatCompletionResponse:
      type: object
      description: OpenAI-compatible Chat Completions API 响应。实际字段会随所选模型和请求参数变化。
      additionalProperties: true
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
              example: invalid request
            type:
              type: string
              example: invalid_request_error
            code:
              type: string
              example: invalid_request
          additionalProperties: true
        message:
          type: string
          example: insufficient quota
      additionalProperties: true
  responses:
    ChatCompletionResponse:
      description: GPT 提供商模型返回的 Chat Completions API 响应。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ChatCompletionResponse'
    BadRequest:
      description: 请求格式错误、缺少参数、JSON 或 multipart 解析失败、尺寸格式错误。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: API Key 缺失或无效。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    PaymentRequired:
      description: 额度或余额不足。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    RateLimited:
      description: 触发限速、并发限制或上游繁忙。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ServerError:
      description: 网关或上游服务异常。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: BetterToken API Key
      description: >-
        Use your BetterToken API Key as a bearer token. Do not expose API keys
        in frontend browser code, screenshots, logs, tickets, or Git
        repositories.

````