# 快速开始

在线养虾/马平台,开箱即用
目前支持两种Agent:

  • OpenClaw(小龙虾)
  • Hermes(爱马仕)
    遇到任何问题,请在企微群 虎牙Claw 用户沟通群 反馈或者直接联系:liubofang

# OpenClaw绑定到机器人

# 绑定企微个人

  1. 在平台上点击绑定企微机器人按钮
  2. 按照流程指示操作,绑定成功
  3. 在企微找到ClawBot这个机器人聊天即可:

# 绑定企微群机器人

  1. 将ClatBot这个机器人拉进群,然后at它一下,会出来一个配对码
  2. 在平台上,点击绑定企微机器人按钮,选择群绑定,输入配对码
  3. 如果提示绑定成功,则可以在群里正常at它聊天,如果提示配对失败,可截图联系管理员咨询

# 绑定企微业务专属机器人

使用方式同绑定企微群机器人一致

# 绑定到个人微信

  1. 请在微信中,按如下操作,开启微信龙虾插件

  2. 在平台点击绑定微信,获取二维码,使用微信扫码绑定即可

  3. 首次在微信发送消息给ClatBot时,请耐心等待1分钟响应

# Hermes绑定机器人

# 绑定到企微

  1. 在平台上点击绑定企微机器人按钮

    按照提示操作,一般情况下选择一键新建机器人,用手机企微扫码创建
    在手机创建是根据指引操作创建,首次使用可能需要创建权限审批,由上级和企微管理员审批完毕后,再次扫码创建即可
    PS: 只需审批一次权限,后续再扫码创建机器人无需再审批

# 如何API接入

# 获取 API Token 和 Base URL

点击右侧“展开详情”按钮,点击“详情”tab下的API访问选项

# API 直接请求对话

替换变量{Base URL}和{API Token},即可发起调用

curl --location --request POST '{Base URL}/chat/completions' \
--header 'Authorization: Bearer {API Token}' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--header 'Connection: keep-alive' \
--header 'sandbox-session-id: {session-id 可选}' \
--data-raw '{
    "model": "openclaw",
    "messages": [{"role":"user","content":"hi"}]  
}'

注意:关于会话状态说明

  • 可以在header中指定sandbox-session-id,实现某个对话的多轮对话,当session id一致时,会自动保持在同一个对话中,进行多轮对话,此时messages只需提供最新的user消息
  • 如果不指定session id,可以在messages中自己维护历史上下文,与openai兼容格式保持一致表现
  • 如果即不指定session id,也不在messages列表中维护上下文,仅提供最新的user message,则每次都相当于是一个新对话

# 海智LLM平台接入虎牙Claw

在海智LLM平台中添加模型,后续在海智平台上使用任何模式的应用,都能选择该模型。 具体步骤为:

  1. 进入海智LLM平台 (opens new window),点击右上角的“设置”按钮
  2. 选择“模型供应商”,鼠标悬挂在“海聪私有部署”的“显示模型”
  3. 点击右侧的添加模型
  4. 填写表单:API Token 和Base URL

# 如何将对话嵌入到其它网站中

嵌入到网站中,将Agent提供给其它网站用户访问。先打开“公开沙箱”按钮,再将iframe嵌入到网站的目标位置。“公开沙箱”则允许所有用户通过iframe与Agent会话。

<iframe
 src="{url}"
 style="width: 100%; height: 100%; min-height: 700px"
 frameborder="0"
 allow="microphone">
</iframe>

# 嵌入时支持传入参数

可在iframe的src指定的url中设置参数,支持指定专家ID、iframe主题、打开iframe时自动发出的消息。专家ID获取:点击“专家团队”tab,复制对应专家的ID。

样例:https://claw.huya.info/chatbot/{your_sandbox_id}?prompt=hello&agent=main&theme=light

参数 说明
agent 专家ID。默认main
theme iframe白天黑夜主题,dark或light。默认dark
prompt 打开iframe时,自动发出的一条用户消息

# 环境变量(当前暂时仅支持龙虾)

支持获取运行时环境变量,从而在skill/工具调用时支持其他操作,比如:skill中鉴权、打印用户日志、上报审计等

环境变量 说明
HUYACLAW_SESSION_TURN_USER_ID 对话者id(不包含dw_),该值在群聊中随不同对话者进行更新,并且生命周期仅为单次对话,在网页或者私聊中,为真实对话者oa id
HUYACLAW_SESSION_TURN_ENCRYPTED_USER_ID 加密对话者id后的密文
HUYACLAW_USER_NAME 龙虾创建者id(不包含dw_)
HUYACLAW_SESSION_KEY 会话key
HUYACLAW_MODEL 使用的模型

# 验证对话者id

每次发起对话时会自动加密对话者id得到密文,赋值到HUYACLAW_SESSION_TURN_ENCRYPTED_USER_ID环境变量。可调用一下接口来验证密文和对话者id是否一致,以实现严格的用户鉴权。调用接口时需要替换占位符${API Token}${HUYACLAW_SESSION_TURN_USER_ID}${HUYACLAW_SESSION_TURN_ENCRYPTED_USER_ID}为真实值。其中${API Token}这里获取。

验证明文密文

curl --location --request POST 'http://claw.huya.info/openapi/v1/openclaw/user-id/decrypt' \
--header 'Authorization: Bearer ${API Token}' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--header 'Connection: keep-alive' \
--data-raw '{
    "userId": "${HUYACLAW_SESSION_TURN_USER_ID}",
    "encryptedUserId": "${HUYACLAW_SESSION_TURN_ENCRYPTED_USER_ID}"
}'

正确匹配,响应结构体

{
    "code": 0,
    "message": "success",
    "msg": "success",
    "data": {
        "matched": true,
        "encryptTimestamp": 1780908201
    }
}

密文错误,响应结构体

{
    "error": true,
    "error_code": "BUSINESS_ERROR",
    "message": "userId 密文格式错误"
}