> ## 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.

# API OpenAI Chat Completions

> Use a API Chat Completions compatível com OpenAI da BetterToken com URL completa, Bearer API Key e exemplos em curl, Python e JavaScript.

Chame Chat Completions compatível com OpenAI usando `POST https://www.bettertoken.ai/v1/chat/completions`. A maioria das ferramentas externas recebe a Base URL `https://www.bettertoken.ai/v1` e adiciona `/chat/completions` automaticamente.

## Configurações principais

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

## Pré-requisitos

* <a href={"https://bettertoken.ai/register"}>Crie uma BetterToken API Key</a>
* Copie um ID de modelo da <a href={"https://bettertoken.ai/pricing"}>model plaza</a> ou da caixa **Setup** da chave
* Prepare um terminal com `curl` ou Python 3 / Node.js

## Instalação

<Tabs>
  <Tab title="curl">
    `curl` não precisa de SDK. Confirme que `curl --version` funciona no 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>

## Configuração manual

### 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"
      }
    ]
  }'
```

### SDK Python

```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)
```

### SDK JavaScript

```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);
```

## Verificar a conexão

No Playground à direita:

1. Informe `YOUR_API_KEY` em **Authorization**.
2. Substitua `model` por `YOUR_MODEL_ID`.
3. Edite `messages` e envie a solicitação.

O Playground já usa a URL completa `https://www.bettertoken.ai/v1/chat/completions`.

Uma resposta `200` com saída do modelo em `choices[0].message.content` confirma a conexão.

## Trocar de modelo

Substitua `YOUR_MODEL_ID` pelo ID completo da model plaza ou da caixa **Setup**. Não encurte o ID com base no nome exibido.

## Erros comuns

| Erro                  | Correção                                                                                                                            |
| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `401`                 | Confirme `Authorization: Bearer YOUR_API_KEY` e copie novamente a BetterToken API Key.                                              |
| `404`                 | Chamadas HTTP diretas usam `https://www.bettertoken.ai/v1/chat/completions`; `base_url` de SDK usa `https://www.bettertoken.ai/v1`. |
| Modelo não encontrado | Use o ID completo da model plaza ou da caixa **Setup**.                                                                             |
| Solicitação inválida  | Confirme que `messages` é um array e que cada item tem `role` e `content`.                                                          |

## Configuração avançada

### Provedores compatíveis

| Provedor | Status              |
| -------- | ------------------- |
| Claude   | Sem suporte         |
| GPT      | Configuração manual |
| Kimi     | Configuração manual |
| GLM      | Configuração manual |

<Note>Os status se aplicam ao método de configuração do BetterToken descrito nesta página.</Note>

<Accordion title="O que significa cada método de configuração">
  * **Configuração manual**: informe a API Key, a Base URL e o Model.
  * **Sem suporte**: ainda não há um método verificado de conexão direta.
</Accordion>

## Detalhes técnicos

<Accordion title="Base URL e URL completa da solicitação">
  Ferramentas que exigem uma URL completa, como GitHub Copilot e TRAE, usam `https://www.bettertoken.ai/v1/chat/completions`. Ferramentas que adicionam o caminho sozinhas, como Cursor, Cline, OpenCode, n8n e Dify, usam apenas `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.

````