curl -X POST https://octopusx.ai/v1/chat/completions \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "gpt-4o",
"messages": [
{ "role": "system", "content": "你是一个 API 文档助手。" },
{ "role": "user", "content": "生成一个接口说明摘要。" }
],
"stream": false
}'
{
"id": "chatcmpl_abc123",
"object": "chat.completion",
"created": 1735689600,
"model": "gpt-4o",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "该接口接收统一对话消息，并根据模型生成一次性完整回复。"
},
"finish_reason": "stop"
}
],
"usage": {
"prompt_tokens": 31,
"completion_tokens": 24,
"total_tokens": 55
}
}
{
"error": {
"message": "field model is required",
"type": "invalid_request_error",
"param": "",
"code": "invalid_request"
}
}
{
"error": {
"message": "Invalid API key provided",
"type": "invalid_request_error",
"param": "",
"code": "invalid_api_key"
}
}
{
"error": {
"message": "用户额度不足",
"type": "new_api_error",
"param": "",
"code": "insufficient_user_quota"
}
}
{
"error": {
"message": "当前请求频率过高，请稍后再试",
"type": "new_api_error",
"param": "",
"code": "too_many_requests"
}
}
{
"error": {
"message": "bad response body",
"type": "new_api_error",
"param": "",
"code": "bad_response_body"
}
}
OpenAI 格式
通用对话接口（默认非流式）
使用 OpenAI Chat Completions 兼容格式发起对话，并一次性返回完整结果。
POST
https://octopusx.ai
/
v1
/
chat
/
completions
curl -X POST https://octopusx.ai/v1/chat/completions \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "gpt-4o",
"messages": [
{ "role": "system", "content": "你是一个 API 文档助手。" },
{ "role": "user", "content": "生成一个接口说明摘要。" }
],
"stream": false
}'
{
"id": "chatcmpl_abc123",
"object": "chat.completion",
"created": 1735689600,
"model": "gpt-4o",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "该接口接收统一对话消息，并根据模型生成一次性完整回复。"
},
"finish_reason": "stop"
}
],
"usage": {
"prompt_tokens": 31,
"completion_tokens": 24,
"total_tokens": 55
}
}
{
"error": {
"message": "field model is required",
"type": "invalid_request_error",
"param": "",
"code": "invalid_request"
}
}
{
"error": {
"message": "Invalid API key provided",
"type": "invalid_request_error",
"param": "",
"code": "invalid_api_key"
}
}
{
"error": {
"message": "用户额度不足",
"type": "new_api_error",
"param": "",
"code": "insufficient_user_quota"
}
}
{
"error": {
"message": "当前请求频率过高，请稍后再试",
"type": "new_api_error",
"param": "",
"code": "too_many_requests"
}
}
{
"error": {
"message": "bad response body",
"type": "new_api_error",
"param": "",
"code": "bad_response_body"
}
}
通用对话接口（默认非流式）
适用于后台任务、结构化输出、短问答和不需要实时展示生成过程的场景。省略stream 或传入 false 时，接口一次性返回完整 chat.completion 对象。
请求体
对话消息数组。每条消息至少包含
role 与 content。省略或传
false 时为非流式响应。指定输出格式。常用于 JSON 输出或 JSON Schema 结构化输出。
函数调用工具列表。
控制工具调用策略。
采样温度。默认值由上游模型决定。
核采样参数。
最大生成 token 数。
随机种子。上游支持时可提升复现性。
请求示例
curl -X POST https://octopusx.ai/v1/chat/completions \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "gpt-4o",
"messages": [
{ "role": "system", "content": "你是一个 API 文档助手。" },
{ "role": "user", "content": "生成一个接口说明摘要。" }
],
"stream": false
}'
结构化输出
curl -X POST https://octopusx.ai/v1/chat/completions \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "gpt-4o",
"messages": [
{ "role": "user", "content": "提取这句话的主题和语气：这个版本发布节奏很稳。" }
],
"response_format": {
"type": "json_schema",
"json_schema": {
"name": "analysis",
"schema": {
"type": "object",
"properties": {
"topic": { "type": "string" },
"tone": { "type": "string" }
},
"required": ["topic", "tone"]
}
}
}
}'
响应示例
{
"id": "chatcmpl_abc123",
"object": "chat.completion",
"created": 1735689600,
"model": "gpt-4o",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "该接口接收统一对话消息，并根据模型生成一次性完整回复。"
},
"finish_reason": "stop"
}
],
"usage": {
"prompt_tokens": 31,
"completion_tokens": 24,
"total_tokens": 55
}
}
{
"error": {
"message": "field model is required",
"type": "invalid_request_error",
"param": "",
"code": "invalid_request"
}
}
{
"error": {
"message": "Invalid API key provided",
"type": "invalid_request_error",
"param": "",
"code": "invalid_api_key"
}
}
{
"error": {
"message": "用户额度不足",
"type": "new_api_error",
"param": "",
"code": "insufficient_user_quota"
}
}
{
"error": {
"message": "当前请求频率过高，请稍后再试",
"type": "new_api_error",
"param": "",
"code": "too_many_requests"
}
}
{
"error": {
"message": "bad response body",
"type": "new_api_error",
"param": "",
"code": "bad_response_body"
}
}
响应字段
模型生成的文本内容。发生工具调用时可能为
null。模型请求调用的函数工具。
本次请求的 token 用量。
相关接口
⌘I