快速开始

本页沿用成熟的文档站结构，用最短路径带你把 Cubicspaces API 接进应用。

1. 获取 API Key

在 Cubicspaces 控制台创建项目后，你会拿到专属 API Key。所有请求都需要在 Authorization 头中传入：

Authorization: Bearer YOUR_API_KEY

2. 设置基础地址

所有 OpenAI 兼容接口统一使用下面的基础地址：

https://api.cubicspaces.cloud/v1

3. 安装官方 SDK

Python

pip install openai

Node.js

npm install openai

cURL

# 无需安装 SDK，可直接发起 HTTP 请求

4. 发送第一个聊天请求

Python

from openai import OpenAI

client = OpenAI(
    api_key="YOUR_API_KEY",
    base_url="https://api.cubicspaces.cloud/v1"
)

response = client.chat.completions.create(
    model="gpt-4o-mini",
    messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "介绍一下 Cubicspaces。"}
    ]
)

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

Node.js

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: "YOUR_API_KEY",
  baseURL: "https://api.cubicspaces.cloud/v1"
});

const response = await client.chat.completions.create({
  model: "gpt-4o-mini",
  messages: [
    { role: "system", content: "You are a helpful assistant." },
    { role: "user", content: "介绍一下 Cubicspaces。" }
  ]
});

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

cURL

curl https://api.cubicspaces.cloud/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "model": "gpt-4o-mini",
    "messages": [
      {"role": "system", "content": "You are a helpful assistant."},
      {"role": "user", "content": "介绍一下 Cubicspaces。"}
    ]
  }'

5. 常用接口

聊天接口

POST /v1/chat/completions
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

模型列表

GET /v1/models
Authorization: Bearer YOUR_API_KEY

用量统计

GET /v1/usage
Authorization: Bearer YOUR_API_KEY

错误处理

常见错误码

错误码	说明
401	认证失败，API Key 无效或已过期
403	当前账户无权访问该模型或接口
429	请求频率超限
500	服务内部错误
503	上游模型服务暂不可用

错误响应格式

{
  "error": {
    "message": "错误描述信息",
    "type": "invalid_request_error",
    "param": "model",
    "code": "unsupported_model"
  }
}

限制说明

限制项	说明
请求频率	根据账户等级和接口类型限制
单次请求最大 Token	根据模型规格限制
并发连接数	根据项目配额限制
响应超时时间	默认 30 秒，可视接口调整

下一步

• 查看 代码示例 了解多语言集成方式
• 阅读 API 参考 浏览完整接口目录
• 前往 OpenAI Chat 直接调试聊天接口