ChatDLM API文档

目录
  1. 1\. 认证
  2. 2\. 端点详情
  3. 3\. 请求参数
  4. 4\. 请求示例
  5. 5\. 响应示例
  6. 6\. 错误响应
  7. 7\. 注意事项

基于掩码扩散的并行解码语言模型

响应更快,更准,更全,支持高速文本生成

1. 认证

所有请求都必须在请求头中包含API密钥:

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

获取API密钥

您需要先在 官方网站 注册账号,完成身份验证后,在控制台生成并获取API密钥。

2. 端点详情

2.1 请求方式

POST

2.2 请求路由

https://api.chatdlm.com/v1/chat/completions

2.3 功能描述

基于用户输入生成模型响应,支持流式输出和参数化配置。

3. 请求参数

参数 类型 是否必需 默认值 范围/枚举 描述
model string 必需 - ChatDLM, ChatDLM-MoE 指定使用的模型版本
messages object[] 必需 - - 消息数组,格式为 [{"role": "user", "content": "用户输入"}]
stream boolean 可选 false - 是否启用流式响应(适用于长文本实时输出)
max_tokens integer 可选 512 1 ≤ x ≤ 8192 生成内容的最大token数,控制响应长度
temperature number 可选 0.7 0.1 ≤ x ≤ 1 控制输出随机性,值越高越随机(创意场景建议0.8+,精确任务建议0.2-)
top_p number 可选 0.8 0.1 ≤ x ≤ 1 核采样参数,限制概率分布范围,与temperature互斥

4. 请求示例

4.3请求示例一

# 非流式请求示例
curl -X POST "https://api.chatdlm.com/v1/chat/completions" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "ChatDLM",
    "messages": [{"role": "user", "content": "1+1等于几"}],
    "stream": false,
    "max_tokens": 512,
    "temperature": 0.7,
    "top_p": 0.8
  }'

4.2示例二

# 流式请求示例(返回SSE格式)
curl -X POST "https://api.chatdlm.com/v1/chat/completions" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "ChatDLM",
    "messages": [{"role": "user", "content": "请解释量子计算原理"}],
    "stream": true
  }'

5. 响应示例

5.1 非流式响应

{
  "id": "chatcmpl-0196a990-6b5f-73ad-b5d6-b2118e1968fe",
  "object": "chat.completion",
  "created": 1746601536,
  "model": "ChatDLM",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "1+1等于2。这是一个基本的算术运算,表示两个单位数量相加的结果。"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 50,
    "completion_tokens": 32,
    "total_tokens": 82
  }
}

5.2 流式响应(SSE格式片段)

data: {"choices":[{"delta":{"content":"量子"},"index":0,"finish_reason":null}],"created":1746601536,"id":"chatcmpl-123","model":"ChatDLM","object":"chat.completion.chunk"}

data: {"choices":[{"delta":{"content":"计算"},"index":0,"finish_reason":null}],"created":1746601536,"id":"chatcmpl-123","model":"ChatDLM","object":"chat.completion.chunk"}

data: {"choices":[{"delta":{"content":"是利用"},"index":0,"finish_reason":null}],"created":1746601536,"id":"chatcmpl-123","model":"ChatDLM","object":"chat.completion.chunk"}

data: [DONE]

6. 错误响应

当请求发生错误时,返回以下格式的JSON对象:

{
  "error": {
    "code": 400,
    "message": "Invalid request parameters",
    "type": "invalid_request_error"
  }
}

常见错误码:

  • 401 Unauthorized:API密钥无效或未提供

  • 400 Bad Request:请求参数格式错误

  • 429 Too Many Requests:请求频率超出限制

  • 500 Internal Server Error:服务器内部错误

  • 504 Gateway Time-out:服务器请求超时

  • Request failed.:请检查入参是否过长以及有不合法字符

7. 注意事项

  • 所有请求必须使用HTTPS协议

  • API密钥严格保密,避免泄露

  • 免费套餐有请求频率和每日调用次数限制,升级套餐可提高额度

  • 模型响应受训练数据限制,不保证100%准确性

  • 最后更新 2026-8-25 18:43:09