文档中心

ArkClaw 企业版

请输入

ClawInstance

GetClawInstanceChatToken - 获取ArkClaw实例临时会话凭据

获取访问ArkClaw实例的临时会话凭据，供后续通过WebSocket（wss）协议与实例建立实时连接时使用。

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：GetClawInstanceChatToken

要执行的操作，取值：GetClawInstanceChatToken。

Version string 必选示例值：2026-05-01

API的版本，取值：2026-05-01。

InstanceId string 必选示例值：ci-yemj8hssg0wr****

ArkClaw实例ID。

SpaceId string 必选示例值：csi-yei8347ta8xmf5****

ArkClaw实例所属空间ID。可以在ArkClaw控制台“空间概览”页面的“基本信息”获取。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

ChatToken string 示例值：c93e7d7b-f788-4925-968a-fac3425b****

使用WebSocket与实例连接时需要的一次性认证Token。使用Token进行wss连接之后Token即失效。

Endpoint string 示例值：sd6unjsj41ve****.[apigateway-cn-beijing.volceapi.com](https://security.feishu.cn/link/safety?target=http%3A%2F%2Fapigateway-cn-beijing.volceapi.com&scene=ccm&logParams=%7B%22location%22%3A%22ccm_mindnote%22%7D&lang=zh-CN)

使用websocket与实例连接时需要的访问域名。

InstanceId string 示例值：ci-yemj8hssg0wr****

ArkClaw实例的ID。

请求示例

GET /?Action=GetClawInstanceChatToken&Version=2026-05-01&InstanceId=ci-yemj8hssg0wr****&SpaceId=csi-yei8347ta8xmf5**** HTTP/1.1​
Host: https://arkclaw.cn-beijing.volcengineapi.com​
X-Date: 20260605T125222Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260605/cn-beijing/arkclaw/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
​

返回示例

{​
  "ResponseMetadata": {​
    "RequestId": "202606052052300200632****",​
    "Action": "GetClawInstanceChatToken",​
    "Version": "2026-05-01",​
    "Service": "arkclaw",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "ChatToken": "c93e7d7b-f788-4925-968a-fac3425b****",​
    "Endpoint": "sd6unjsj41ve****.[apigateway-cn-beijing.volceapi.com](https://security.feishu.cn/link/safety?target=http%3A%2F%2Fapigateway-cn-beijing.volceapi.com&scene=ccm&logParams=%7B%22location%22%3A%22ccm_mindnote%22%7D&lang=zh-CN)",​
    "InstanceId": "ci-yemj8hssg0wr****"​
  }​
}​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	MissingParameter.InstanceId	The required parameter InstanceId is not supplied.	参数InstanceId不能为空。
400	MissingParameter.SpaceId	The required parameter SpaceId is not supplied.	参数SpaceId不能为空。
404	InvalidSpace.NotFound	The specified Space does not exist.	指定ArkClaw空间不存在。
404	InvalidInstance.NotFound	The specified Instance does not exist.	指定ArkClaw实例不存在。
429	FlowLimitExceeded	The request was rejected due to flow control.	请求触发限流。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。

最近更新时间：2026.06.05 21:31:12

这个页面对您有帮助吗？

有用

无用