API 参考文档

欢迎使用云智AI,本文档将指导您如何与我们的聚合模型进行对接和交互,从而快速的将语言文本模型集成到您的软件或应用中【本站由云智API提供算力支持,官方群聊:https://qm.qq.com/q/VYaHLE93i0】

接口概述

云智AI API 遵循 RESTful 设计原则,通过标准的 HTTP 请求进行交互,并返回 JSON 格式的数据,所有模型均采用官方镜像/Ollma/本地部署。您的请求都应发送至我们的付费端点进行中转

付费端点:

https://chat.jkyai.top/v1/chat/completions/

身份认证

所有对 API 的请求都需要通过 API 密钥进行认证。您需要在 HTTP 请求的 Authorization 头部中提供您的密钥。

密钥格式为 Bearer YOUR_API_KEY,请将 YOUR_API_KEY 替换为您在控制台获取的密钥。

Authorization: Bearer sk-512e722ec9abba0bf9bb8b8ed606603749a0b9bdcb27973a

注意: 请妥善保管您的API密钥,不要在客户端代码或公开仓库中泄露。所有通过您密钥发起的请求都将被计费!

请求格式

聊天补全接口(Chat Completions)是我们的核心接口。您需要向该接口发送一个 POST 请求,请求体为 JSON 格式。

  • 方法: POST
  • 地址: https://chat.jkyai.top/v1/chat/completions/
  • 头部:
    • Content-Type: application/json
    • Authorization: Bearer YOUR_API_KEY

参数说明

请求参数

参数 类型 状态 描述
model string 必填 要使用的模型ID,例如 "Phi-4"。请参考模型中心获取可用模型列表。
messages array 必填 一个消息对象数组,用于描述对话上下文。每个对象包含 role (system, user, assistant) 和 content
stream boolean 可选 默认为 false。如果设置为 true,API 将以 Server-Sent Events (SSE) 的方式流式返回数据块。
max_tokens integer 可选 输入标记和生成标记的总长度受模型的上下文长度限制,默认为 1000。
temperature number 可选 控制生成文本的随机性,介于 0 和 2 之间。值越高结果越随机,值越低结果越确定。默认为 1。
top_p number 可选 一种替代 temperature 的采样方法。模型会考虑概率质量加起来为 top_p 的 token。默认为 1。
user string 可选 代表您最终用户的唯一标识符,有助于我们监控和检测滥用行为。

返回参数 (非流式)

{
  "id": "chatcmpl-xxxxxxxxxxxx",
  "object": "chat.completion",
  "created": 1721369688,
  "model": "gpt-4o-mini-2024-07-18",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "你好!有什么可以帮助你的吗?"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 10,
    "completion_tokens": 12,
    "total_tokens": 22
  }
}

返回参数 (流式)

stream: true 时,您会收到一系列事件。每个事件都是一个 JSON 对象,最后一个事件为 [DONE]

data: {"id":"chatcmpl-xxx","object":"chat.completion.chunk","created":1721369700,"model":"gpt-4o-mini-2024-07-18","choices":[{"index":0,"delta":{"role":"assistant"},"finish_reason":null}]}

data: {"id":"chatcmpl-xxx","object":"chat.completion.chunk","created":1721369700,"model":"gpt-4o-mini-2024-07-18","choices":[{"index":0,"delta":{"content":"你"},"finish_reason":null}]}

data: {"id":"chatcmpl-xxx","object":"chat.completion.chunk","created":1721369700,"model":"gpt-4o-mini-2024-07-18","choices":[{"index":0,"delta":{"content":"好!"},"finish_reason":null}]}

data: {"id":"chatcmpl-xxx","object":"chat.completion.chunk","created":1721369700,"model":"gpt-4o-mini-2024-07-18","choices":[{"index":0,"delta":{},"finish_reason":"stop","usage":{"prompt_tokens":10,"completion_tokens":12,"total_tokens":22}}]}

data: [DONE]

错误码

如果请求失败,API会返回一个标准的HTTP错误码和一个包含详细信息的JSON对象。

HTTP状态码 错误类型 描述
400 Bad Request invalid_request_error 请求无效。可能是缺少必填参数,或JSON格式错误。
401 Unauthorized authentication_error 认证失败。API密钥无效、格式错误或未提供。
402 Payment Required insufficient_balance 账户余额不足以完成本次请求。
404 Not Found not_found_error 请求的资源或模型不存在。
429 Too Many Requests rate_limit_error 请求频率超过了限制。
500 Internal Server Error api_error / upstream_error 服务器内部错误或上游服务出现问题。请稍后重试。

代码示例

下面是在不同编程语言中调用聊天补全API的示例。请记得将 YOUR_API_KEY 替换为您的真实密钥。

cURL

curl https://chat.jkyai.top/v1/chat/completions/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "model": "gpt-4o-mini-2024-07-18",
    "messages": [
      {
        "role": "system",
        "content": "你是一个乐于助人的AI助手。"
      },
      {
        "role": "user",
        "content": "你好,请做个自我介绍。"
      }
    ]
  }'

Python

import requests
import json

api_key = "YOUR_API_KEY"
url = "https://chat.jkyai.top/v1/chat/completions/"

headers = {
    "Content-Type": "application/json",
    "Authorization": f"Bearer {api_key}"
}

data = {
    "model": "gpt-4o-mini-2024-07-18",
    "messages": [
        {"role": "system", "content": "你是一个乐于助人的AI助手。"},
        {"role": "user", "content": "你好,请做个自我介绍。"}
    ],
    "stream": False # 设置为True以使用流式传输
}

response = requests.post(url, headers=headers, data=json.dumps(data))

if response.status_code == 200:
    print(response.json())
else:
    print(f"请求失败,状态码: {response.status_code}")
    print(response.text)

Node.js (axios)

const axios = require('axios');

const apiKey = 'YOUR_API_KEY';
const url = 'https://chat.jkyai.top/v1/chat/completions/';

const headers = {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${apiKey}`
};

const data = {
    model: 'gpt-4o-mini-2024-07-18',
    messages: [
        { role: 'system', content: '你是一个乐于助人的AI助手。' },
        { role: 'user', content: '你好,请做个自我介绍。' }
    ]
};

axios.post(url, data, { headers })
    .then(response => {
        console.log(response.data);
    })
    .catch(error => {
        console.error('请求出错:', error.response ? error.response.data : error.message);
    });

PHP (cURL)

<?php

$apiKey = 'YOUR_API_KEY';
$url = 'https://chat.jkyai.top/v1/chat/completions/';

$headers = [
    'Content-Type: application/json',
    'Authorization: Bearer ' . $apiKey
];

$data = [
    'model' => 'gpt-4o-mini-2024-07-18',
    'messages' => [
        ['role' => 'system', 'content' => '你是一个乐于助人的AI助手。'],
        ['role' => 'user', 'content' => '你好,请做个自我介绍。']
    ]
];

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($http_code == 200) {
    echo $response;
} else {
    echo "请求失败,HTTP状态码: " . $http_code . "\n";
    echo "响应内容: " . $response;
}

?>

计费标准

我们采用基于Token用量的统一定价模式,无论您选择哪款语言大模型,计费标准都保持一致,让您可以专注于业务创新,无需担心复杂的定价策略【兼容OpenAI格式,您可以通过请求日志查看相关费用】

项目 价格 (元 / 1M Tokens) 说明
输入 (Prompt Tokens) 1.00 元 您在请求中发送给模型的Token数量
输出 (Completion Tokens) 3.00 元 AI模型为您生成并返回的Token数量

购买与充值

如需购买新的API密钥或为现有密钥充值,请联系我们的客服QQ:3475074480