跳到主要内容

使用 SSE 聊天

POST https://chat.agentweave.ai/api/v1/chat/agent/{agent_id}

请求​

路径参数​

agent_id: 您的agent id

请求头​

Authorization: AgentWeave用户访问令牌 或者 Api密钥

请求体​

  • content (必需): 您输入的文本.
  • type (必需): "text" 或者 "media", 决定智能体输出的类型.
  • id (可选): 您生成的 uuidv4, 用于标识输入的文本.
  • thread_id (可选): thread 保存了您之前的对话, 如果开启新对话则留空, 所有之后的消息必须包含之前返回的 thread_id 来保证上下文的一致性. thread_id 使用 ULID 格式.
  • org_id (可选): 选择用户所属的, 要进行积分扣除的组织. 在积分扣除时使用该字段. 如果用户不使用组织积分则不填该字段.
  • pay_account (可选): 如果提供了 org_id, pay_account 为必需. 填写 "Person" 或 "Org" 来指定扣除积分的主体是用户还是组织.
  • file (可选):
    • file_url (可选): 如果想让智能体处理文件, 您必须提供 file_url, 并且 file_url 必需可以公开访问. 查看上传文件章节来给智能体上传文件. 上传文件不消耗积分.

请求体示例​

{
  "content": "介绍chatgpt",
  "type": "text"
}

响应​

  • action: 消息类型. "send_message.delta" 表示智能体输出片段, "send_message.completed" 表示生成完成, 并且 message 字段包含完整的智能体生成内容. "send_message.heartbeat" 表示心跳消息, 不包含 message 字段.
  • message:
    • agent_id
    • client_message_id: 标识您输入的文本的 uuidv4.
    • content: 智能体输出的内容.
    • speech_content: {}.
    • from: "assistant".
    • id: 标识智能体输出的内容的 uuidv4.
    • thread_id: 这条消息所属的 thread, thread 保存了您之前的对话.
    • timestamp: 内容生成时的毫秒时间戳.
    • type: "text".
    • user_id: agent_id.
  • agent_id
  • result:
    • code: 若成功则返回 201000, 其余表示失败.
    • message: "Successfully." 或者错误信息.

响应示例​

data: {
    action: "send_message.delta",
    message: {
        agent_id: "open_chat_openai_c533c890-c1f0-444c-9bab-15cbae364a92",
        client_message_id: "d6be96fa-5a90-4c11-a661-d7ae96a368eb",
        content: "the",
        speech_content: {},
        from: "assistant",
        id: "a11cee33-68b8-4345-a658-c0736c94e8be",
        thread_id: "01KATMZEAPX5201F9X5SBKKH6N",
        timestamp: 1764031265272,
        type: "text",
        user_id: "open_chat_openai_c533c890-c1f0-444c-9bab-15cbae364a92"
    },
    agent_id: "open_chat_openai_c533c890-c1f0-444c-9bab-15cbae364a92",
    result: {
        code: 201000,
        message: "Successfully."
    }
}