AGTCloud API Docs
文档指南API Reference集成与资源更新与帮助

API Key 与认证

创建和管理 AGTCloud API Key,并配置接口所需的认证 Header。

API Key 用于验证你对 AGTCloud API 的请求身份。大多数接口使用 Bearer API Key;Anthropic Messages 等兼容协议使用专属认证 Header,具体要求以对应 Endpoint 页面为准。

配置值
Base URLhttps://api.agtcloud.cn/v1
大多数接口Authorization: Bearer your-api-key
Anthropic Messagesx-api-key: your-api-key 和 anthropic-version: 2023-06-01

创建 API Key

  1. 前往 API Keys。
  2. 点击创建 API 密钥。
  3. 复制并安全保存你的 API Key。
AGTCloud API Key 管理页面,标出了 API 密钥入口、创建按钮和管理操作区域

妥善保存 API Key

不要在截图、聊天记录、工单或公开代码中展示完整 API Key。疑似泄露时,请禁用或删除旧 Key,并添加新令牌。

使用 API Key

Bearer 认证

使用 https://api.agtcloud.cn/v1 作为 Base URL,并在请求中添加:

Authorization: Bearer your-api-key

/v1 已经包含在推荐的 Base URL 中。组合请求地址时不要再次添加 /v1,否则会产生错误路径。

验证 API Key

请求当前 API Key 可见的模型列表,确认 Base URL 和认证配置是否正确:

curl 'https://api.agtcloud.cn/v1/models' \
  -H 'Authorization: Bearer your-api-key'

Anthropic Messages

调用 Anthropic Messages 兼容接口时,使用 x-api-key 传递 API Key,并提供必需的 anthropic-version:

x-api-key: your-api-key
anthropic-version: 2023-06-01

完整请求要求见 Anthropic Messages。

管理 API Key

在 API Keys 页面可以:

  • 添加用于不同环境或应用的令牌。
  • 禁用不再使用或疑似泄露的令牌。
  • 删除不再需要的令牌。

第三方工具配置

配置使用 OpenAI 兼容协议的第三方工具时,通常需要填写:

配置项填写内容
API Host / Base URLhttps://api.agtcloud.cn/v1
API Key当前账户创建的 API Key
模型当前站点和账户可用的模型 ID

模型 ID 可以从模型广场获取。具体配置方式请查看第三方集成。

安全管理

正式服务应通过服务端环境变量或密钥管理服务读取 API Key:

export AGTCLOUD_API_KEY='your-api-key'
  • 不要将 API Key 写入源码或提交到版本控制系统。
  • 不要将 API Key 发送到浏览器前端、移动端安装包或其他不可信客户端。
  • 为开发、测试和生产环境使用不同的 API Key。
  • API Key 疑似泄露时,应立即禁用或删除旧 Key,并替换为新 Key。

本页目录