WebAgent Vibecoding

如果你正在 IDE 里用 LLM 写代码——Cursor、Claude Code、Aider、Continue……——你只需把 WebAgent 当作一组 URL 喂给它，它会替你写集成。

三个 URL 必记

URL	是什么	喂给谁
/web-agent/llms.txt	全站每页 + 一句描述的目录	任何 LLM agent——快速扫一眼
/web-agent/llms-full.txt	整站文档拼一个 markdown 文件（约 200 KB）	长上下文模型——直接当 system prompt 粘贴
/openapi/v1.json	OpenAPI 3.1 spec（语言无关）	代码生成型 agent——它能从这个生成强类型 client

这三个 URL 永久稳定。即使内部页面改名也不会变。

拿来即用 prompt

复制到你的 IDE 系统 prompt / 规则文件 / 第一条消息：

你正在集成 WebAgent。参考文档：
- https://docs.web-agent.asix.inc/zh/llms-full.txt   （整站文档单文件，中文）
- https://docs.web-agent.asix.inc/openapi/v1.json    （OpenAPI 3.1 spec）

API 约定：
- Base URL：https://api.web-agent.asix.inc
- Bearer 鉴权：header `Authorization: Bearer wa_…`
- path 隔离 project：/v1/projects/{project_id}/...
- wire 字段一律 snake_case；decimal 用 JSON 字符串（"10.00" 不是 10.00）
- 大多数变更端点支持 Idempotency-Key

SDK 包：
- Python: `pip install web-agent-sdk`
- TypeScript: `npm install web-agent-sdk`

两边 SDK 都自带 Last-Event-ID SSE 重连。优先用 SDK，除非用户要求纯 HTTP。

写代码前一律先读 OpenAPI spec——绝不靠猜字段名。

Cursor

.cursor/rules/webagent.md：

---
description: WebAgent 集成约定
globs: ["**/*.{ts,tsx,py}"]
---

写 WebAgent 代码时遵循 https://docs.web-agent.asix.inc/zh/llms-full.txt
字段名以 https://docs.web-agent.asix.inc/openapi/v1.json 为准——不允许猜
默认用官方 SDK（`web-agent-sdk`），用户特别要求才用 raw HTTP

Claude Code

加到项目 CLAUDE.md：

## WebAgent 集成

参考：https://docs.web-agent.asix.inc/zh/llms-full.txt
OpenAPI：https://docs.web-agent.asix.inc/openapi/v1.json
SDK：`web-agent-sdk`（Python 与 TypeScript）

wire 字段全 snake_case。订阅 task 事件用 SDK 的 `.stream()`，自带 `Last-Event-ID` 重连。

Console "Get Code" 对话框

最快拿到能跑的代码：打开 Console，填表，点 Get Code。四个 tab（给 LLM agent 的 Prompt / Python / TypeScript / cURL），全部带你的真实 key 和当前配置。粘贴进编辑器即可。

为什么这套有效

• URL 由我们维护，跨大版本不会 404
• llms-full.txt 是 markdown 不是 HTML——每个 LLM 都能干净吃下
• OpenAPI spec 是 SDK / Console 共同的单一真相，没有漂移

接下来

• Quickstart —— 5 分钟跑通第一个 task
• API 参考 —— 交互式 + Try-it