OpenClaw作为一个开源的个人 AI 代理工具,不仅支持本地部署和多渠道聊天,还提供了灵活的 API 接口,便于开发者进行二次集成、自动化任务调用或构建自定义客户端。通过 OpenClaw 的 Gateway API,你可以实现消息发送、会话管理、模型调用、文件操作等多种功能。本文将详细介绍 OpenClaw API 的调用方式,并以 Postman 为例,提供完整的请求配置和实战示例,帮助你快速上手。
OpenClaw 的核心服务是 Gateway,通常运行在本地或服务器的 端口(默认 ws://127.0.0.1:18789 或 http://127.0.0.1:18789)。API 主要分为两类:
官方文档中对 API 的描述较为简洁,但结合实际部署经验,Gateway 支持 OpenAI-compatible 的消息接口,同时提供原生的 OpenClaw 专属端点。调用前需确保:
在调用 API 前,必须先完成 OpenClaw 的部署和 Gateway 启动。以下是简要步骤(完整部署可参考官方一键脚本):
完成后,API 即可使用。建议在本地测试,远程访问时使用 SSH 隧道:
Postman 是调用 REST 和 WebSocket API 的绝佳工具。以下是通用配置步骤:
OpenClaw 提供了一系列 HTTP 端点,用于状态查询和管理。
最简单的接口,用于确认服务是否正常。
Postman 配置:
– 方法:GET
– URL:
预期响应:
兼容 OpenAI 格式,返回可用模型。
Postman 配置:
– 方法:GET
– URL:
– Headers:
示例响应:
最核心的接口,兼容 OpenAI Chat Completions 格式,支持流式和非流式。
Postman 配置:
– 方法:POST
– URL:
– Headers:
–
– Body(raw JSON):
非流式响应示例:
开启流式(stream: true):
响应会以 格式逐块返回,Postman 会自动显示流式输出。
Postman 示例(删除会话):
– 方法:DELETE
– URL:
WebSocket 是 OpenClaw 最强大的交互方式,支持多轮对话、工具调用、主动推送。
OpenClaw WebSocket 采用标准 JSON 帧,核心字段:
支持的 type 类型表:
OpenClaw 支持强大的工具链(Skills),通过 API 可直接触发。
示例:浏览器自动化(POST /v1/chat/completions + tools)
Body 中加入 tools 数组:
OpenClaw 会自动返回 tool_call 帧,Postman 流式面板可实时查看执行进度。
文件上传示例(multipart/form-data):
使用 POST ,然后在消息中引用 file_id。
通过以上配置和示例,你已经可以熟练使用 Postman 调用 OpenClaw API 了。无论是快速测试新功能,还是构建自动化工作流,OpenClaw 的 API 都提供了极高的灵活性。建议结合官方文档和 GitHub 源码深入探索更多高级特性,让你的个人 AI 助手发挥最大价值。
延展阅读:
如何学习使用人工智能?通俗易懂的人工智能(AI)入门教程。
抖音如何进行双实名认证?双实名有什么作用?区分生活/工作账号、提升安全、满足运营需求,企业号/火山版双路径详解!
客服AI-Agent:大模型智能客服,实现99%解决率!
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容,请联系我们,一经查实,本站将立刻删除。
如需转载请保留出处:https://51itzy.com/kjqy/213434.html