快速开始
通过简单的几步,即可开始接入 星云AI开放平台 的强大AI能力。
1
注册账号
创建开发者账号并登录控制台
2
创建密钥
在控制台生成API密钥用于身份认证
3
开始调用
参考文档发起您的第一个API请求
基础信息
API基础URL:
https://api.nebula-ai.com/v1
支持的协议
- HTTPS:所有API请求必须通过HTTPS发起
- HTTP/2:支持HTTP/2协议,提升并发性能
- WebSocket:流式响应支持WebSocket连接
认证方式
所有API请求都需要在请求头中携带API密钥进行身份认证。
请求头格式
http
Authorization: Bearer YOUR_API_KEY
安全提示:请勿在客户端暴露您的API密钥,建议在服务端调用API。
完整请求示例
bash
curl https://api.nebula-ai.com/v1/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer sk-xxxxxxxxxxxxxxxx" \
-d '{
"model": "gpt-4",
"messages": [{"role": "user", "content": "你好"}]
}'
对话接口
发起对话请求,支持单轮问答和多轮上下文对话。
请求地址
POST /v1/chat/completions
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| model | string | 必填 | 模型代码,如 gpt-4, gpt-3.5-turbo |
| messages | array | 必填 | 对话消息列表 |
| temperature | float | 可选 | 随机性,0-2,默认0.7 |
| max_tokens | integer | 可选 | 最大生成token数 |
| stream | boolean | 可选 | 是否流式返回,默认false |
代码示例
php
<?php
$apiKey = 'your-api-key';
$url = 'https://api.nebula-ai.com/v1/chat/completions';
$data = [
'model' => 'gpt-4',
'messages' => [
['role' => 'user', 'content' => '你好']
]
];
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Content-Type: application/json',
'Authorization: Bearer ' . $apiKey
]);
$response = curl_exec($ch);
$result = json_decode($response, true);
echo $result['choices'][0]['message']['content'];
python
import requests
api_key = 'your-api-key'
url = 'https://api.nebula-ai.com/v1/chat/completions'
headers = {
'Authorization': f'Bearer {api_key}',
'Content-Type': 'application/json'
}
data = {
'model': 'gpt-4',
'messages': [
{'role': 'user', 'content': '你好'}
]
}
response = requests.post(url, headers=headers, json=data)
result = response.json()
print(result['choices'][0]['message']['content'])
javascript
const apiKey = 'your-api-key';
const url = 'https://api.nebula-ai.com/v1/chat/completions';
const response = await fetch(url, {
method: 'POST',
headers: {
'Authorization': `Bearer ${apiKey}`,
'Content-Type': 'application/json'
},
body: JSON.stringify({
model: 'gpt-4',
messages: [{role: 'user', content: '你好'}]
})
});
const result = await response.json();
console.log(result.choices[0].message.content);
java
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType,
"{\"model\":\"gpt-4\",\"messages\":[{\"role\":\"user\",\"content\":\"你好\"}]}");
Request request = new Request.Builder()
.url("https://api.nebula-ai.com/v1/chat/completions")
.post(body)
.addHeader("Authorization", "Bearer your-api-key")
.addHeader("Content-Type", "application/json")
.build();
Response response = client.newCall(request).execute();
响应示例
json
{
"id": "chatcmpl-xxxxxxxx",
"object": "chat.completion",
"created": 1699999999,
"model": "gpt-4",
"choices": [{
"index": 0,
"message": {
"role": "assistant",
"content": "你好!很高兴为你服务。"
},
"finish_reason": "stop"
}],
"usage": {
"prompt_tokens": 10,
"completion_tokens": 20,
"total_tokens": 30
}
}
模型列表
平台支持的AI模型及价格信息。
错误码
接口返回的错误码及处理建议。
| 状态码 | 错误码 | 说明 | 处理建议 |
|---|---|---|---|
| 200 | - | 请求成功 | 正常处理响应数据 |
| 400 | invalid_request | 请求参数错误 | 检查请求参数格式 |
| 401 | unauthorized | 认证失败 | 检查API密钥是否正确 |
| 403 | forbidden | 权限不足 | 检查密钥是否有该模型权限 |
| 429 | rate_limit | 请求过于频繁 | 降低请求频率或升级套餐 |
| 500 | server_error | 服务器内部错误 | 稍后重试或联系客服 |
| 503 | service_unavailable | 服务暂时不可用 | 稍后重试 |
错误响应格式
json
{
"error": {
"code": "rate_limit",
"message": "请求过于频繁,请稍后再试",
"type": "api_error"
}
}
SDK下载
官方提供的SDK,简化接入流程。