Skip to content

5 分钟快速开始

本页使用「用户发消息,分身立即回复」接口完成一次最小调用。

1. 获取访问地址和 API Key

在灵谐客户端进入「开放平台」,开启 API 访问并创建密钥。

API Base URL正在读取部署配置…

下文用环境变量保存密钥,避免把真实值留在命令历史或源码中:

bash
export LINGXIE_API_KEY='请替换为刚创建的密钥'
export LINGXIE_API_BASE_URL='请替换为上方地址'

2. 发送第一条消息

bash
curl "$LINGXIE_API_BASE_URL/open/v1/message" \
  -H "Authorization: Bearer $LINGXIE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "messageId": "msg_quickstart_001",
    "externalUserId": "demo_user_001",
    "externalUserName": "体验用户",
    "conversationKey": "default",
    "messageType": "text",
    "text": "你好,请介绍一下自己"
  }'
js
const response = await fetch(`${process.env.LINGXIE_API_BASE_URL}/open/v1/message`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LINGXIE_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    messageId: 'msg_quickstart_001',
    externalUserId: 'demo_user_001',
    externalUserName: '体验用户',
    conversationKey: 'default',
    messageType: 'text',
    text: '你好,请介绍一下自己'
  })
});
console.log(await response.json());
python
import os
import requests

response = requests.post(
    f"{os.environ['LINGXIE_API_BASE_URL']}/open/v1/message",
    headers={"Authorization": f"Bearer {os.environ['LINGXIE_API_KEY']}"},
    json={
        "messageId": "msg_quickstart_001",
        "externalUserId": "demo_user_001",
        "externalUserName": "体验用户",
        "conversationKey": "default",
        "messageType": "text",
        "text": "你好,请介绍一下自己",
    },
    timeout=100,
)
print(response.json())

3. 检查结果

成功响应示例:

json
{
  "code": 0,
  "message": "OK",
  "requestId": "req_example",
  "messageId": "msg_quickstart_001",
  "replyType": "text",
  "replyText": "你好,我是你的灵谐分身……"
}
  • HTTP 状态为 2xx 且 code = 0 才表示调用成功。
  • replyText 是分身回复。
  • requestId 是本次请求的排查标识,建议写入脱敏后的调用日志。
  • 同一用户和同一 conversationKey 会延续同一段上下文。
  • 网络超时前不要用新的 messageId 重试,详见可靠性与重试

下一步可以阅读核心概念,或直接查看消息接口参考