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

# 地址、密钥与模型

> 把客户端连接到正确的部署，并确认模型能力。

## 设置连接信息

先完成[快速开始](/zh/quickstart)，取得模型调用 API Key 和服务地址。本文档统一使用以下环境变量：

```bash theme={null}
export API_BASE_URL='https://gateway.example.com/v1'
export API_KEY='YOUR_API_KEY'
export API_MODEL='YOUR_MODEL_ID'
```

替换三个占位值。`API_BASE_URL` 包含一个 `/v1`，末尾不带 `/`；部署有子路径时保留前缀。正式调用使用管理员提供的 HTTPS 地址。

| 客户端 | 填写示例 |
| - | - |
| OpenAI Python SDK 的 `base_url` | `https://gateway.example.com/v1` |
| OpenAI TypeScript SDK 的 `baseURL` | `https://gateway.example.com/v1` |
| HTTP Chat Completions 地址 | `https://gateway.example.com/v1/chat/completions` |

第三方客户端可能自动添加 `/v1`，请查看它的地址约定。返回 HTML 或 404 时，优先检查域名、子路径及重复的 `/v1`。

## 发送认证信息

使用 `Authorization: Bearer YOUR_API_KEY` 请求头。密钥从环境变量或服务端密钥管理系统读取；不要使用控制台 Cookie、管理凭据，也不要把密钥打包到浏览器应用。需要网页交互时，通过自己的服务端调用网关。

## 选择模型和接口

调用[模型列表](/zh/api-reference/models)，原样使用 `data[].id`。可见模型受账号、密钥权限、分组和部署配置影响，列表不保证每个模型支持所有协议。

* 常规多轮对话使用 [Chat Completions](/zh/api-reference/chat-completions)，由调用方发送消息历史。
* 目标模型支持 Responses 时，可使用 [Responses](/zh/api-reference/responses)。不能只改 URL：请求和响应结构都不同。
* 图片、音频、工具调用、结构化输出、推理选项和流式输出需逐项确认模型及渠道支持。

先验证最小文本请求，再逐项增加可选参数。不要直接照搬其他供应商的模型 ID 或默认参数。

## 迁移现有客户端

保留原有业务提示词，先只替换服务地址、API Key 和模型 ID，再对比成功响应、错误处理和超时行为。不要默认所有 OpenAI 平台功能都能通过兼容网关使用；文件、批处理、后台任务和响应检索等能力需要单独确认。

## 开始构建应用

[多轮对话](/zh/guides/conversations) · [工具调用](/zh/guides/tool-calling) · [结构化输出](/zh/guides/structured-output) · [图片理解](/zh/guides/vision)

[Read in English](/en/guides/api-basics)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.