用途:这是一份 OpenHands API 参考技能,面向需要通过代码调用 OpenHands Cloud(默认 https://app.all-hands.dev,V1 的 /api/v1/... 接口)以及沙箱内 agent server 的常见工作流,包含可直接复制的小型客户端。
主要能力:覆盖启动或检查云端对话、用 start-task 轮询监控异步启动、监控长任务执行状态、为并行或后台工作创建独立 Cloud 对话、对话运行后访问沙箱 agent-server 端点,以及在本地 Agent Canvas 后端或本地 agent server 上启动/检查对话。
鉴权:App server(Cloud)用 Bearer 认证,头为 Authorization: Bearer <OPENHANDS_CLOUD_API_KEY>,推荐环境变量 OPENHANDS_CLOUD_API_KEY,兼容 OPENHANDS_API_KEY。Agent server(沙箱内)用会话认证,头为 X-Session-API-Key: <session_api_key>;其 agent_server_url 与 session_api_key 来自 app server 返回的对话记录中的沙箱/运行时连接字段,或通过 GET /api/v1/sandboxes/search 查找。
必要用法:Cloud 侧启动对话用 POST /api/v1/app-conversations,可能异步返回 start-task;需通过 GET /api/v1/app-conversations/start-tasks?ids=<start_task_id> 轮询到 READY 并取得 app_conversation_id,后续对话操作(如下载轨迹、读取事件)都用该 id,传 start_task_id 会得到 404。常用端点含 /users/me、/app-conversations/search、/app-conversations/count、/conversation/{id}/events/search 与 /events/count、沙箱 pause/resume、轨迹 zip 下载等。本地后端需先检查 /server_info,再 POST /api/conversations;本地 key 来自 LOCAL_BACKEND_API_KEY 或 ~/.openhands/agent-canvas/api-key.txt,可用 OH_SESSION_API_KEY_PATH 覆盖,切勿打印或记录密钥。
限制与建议:并行委派对话建议不超过 5 个,启动前统计 execution_status 为 running 的数量;agent-server 事件 id 是 UUID,不能靠最后一个 id 推断事件总数;Windows PowerShell 等价写法见 references/windows.md。具体平台与计费信息资料未提供。