API 参考

OpenClaw 完整 API 文档,包含所有工具、接口和参数说明

📚 概述

OpenClaw 提供 RESTful API 和 SDK 两种调用方式。所有 API 需要 Bearer Token 认证。

Base URL: http://localhost:3000/api/v1
认证方式: Authorization: Bearer <token>
响应格式: JSON

🤖 Agent API

POST /agent/chat

发送消息给 Agent,获取响应。支持流式和非流式两种模式。

{
"message": "帮我总结今天的日程",
"stream": false,
"context": { "userId": "user123" }
}

参数

参数类型必填说明
messagestring必填用户消息内容
streamboolean可选是否流式响应,默认 false
contextobject可选上下文信息
GET /agent/status

获取 Agent 当前状态,包括活跃任务、资源占用等。

POST /agent/reset

重置 Agent 状态,清空当前对话上下文。

🧩 Skill API

GET /skills

列出已安装的所有 Skill。

POST /skills/install

安装新的 Skill。

{
"source": "github:user/skill-repo",
"version": "latest"
}
DELETE /skills/{name}

卸载指定的 Skill。

GET /skills/{name}/info

获取指定 Skill 的详细信息。

🔧 Tool API

GET /tools

列出所有可用的 Tool 及其参数定义。

POST /tools/{name}/execute

直接执行指定的 Tool。

{
"params": {
"path": "/home/user/file.txt",
"content": "Hello World"
}
}
POST /tools/whitelist

设置 Tool 白名单,限制 Agent 可用的工具。

🧠 Memory API

GET /memory/search

语义搜索记忆内容。

GET /memory/search?query=项目进度&limit=10
POST /memory/add

添加新的记忆条目。

DELETE /memory/{id}

删除指定的记忆条目。

POST /memory/compact

压缩和整理记忆,优化检索效率。

💬 Channel API

GET /channels

列出所有已配置的消息通道。

POST /channels/{type}/send

通过指定通道发送消息。

{
"to": "user_123",
"message": "任务已完成!"
}

⚙️ Config API

GET /config

获取当前配置信息。

PUT /config

更新配置。支持热更新,无需重启。