Vibecoding with WebAgent

If you're writing code with an LLM in your IDE — Cursor, Claude Code, Aider, Continue, anything — you can hand WebAgent to it as one URL. It'll write the integration for you.

Three URLs to know

URL	What it is	Feed it to
/en/web-agent/llms.txt	Short index of every page, with one-line descriptions	Any LLM agent — fast to scan
/en/web-agent/llms-full.txt	The entire documentation site as one plain markdown file (~200 KB)	Long-context models — paste as system prompt
/openapi/v1.json	OpenAPI 3.1 spec for every endpoint	Code-generating agents — they'll write typed clients from this

These URLs are stable. They will never move, even if we rename internal pages.

Drop-in prompt

Copy this into your IDE's system prompt, rules file, or first message:

You are integrating WebAgent. Reference docs:
- https://docs.web-agent.asix.inc/llms-full.txt   (full docs as one file)
- https://docs.web-agent.asix.inc/openapi/v1.json (OpenAPI 3.1 spec)

API conventions:
- Base URL: https://api.web-agent.asix.inc
- Bearer auth: header `Authorization: Bearer wa_…`
- Path-scoped to project: /v1/projects/{project_id}/...
- Wire fields are snake_case. Decimals are JSON strings ("10.00", not 10.00).
- Most mutations accept Idempotency-Key.

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

Both SDKs auto-reconnect SSE streams via Last-Event-ID. Prefer them over hand-rolled HTTP unless asked otherwise.

Always read the OpenAPI spec before guessing field names.

Cursor

.cursor/rules/webagent.md:

---
description: Conventions for integrating with WebAgent
globs: ["**/*.{ts,tsx,py}"]
---

When writing WebAgent code, follow https://docs.web-agent.asix.inc/llms-full.txt.
Field names are authoritative in https://docs.web-agent.asix.inc/openapi/v1.json — never guess.
Use the official SDKs (`web-agent-sdk`) unless the user asks for raw HTTP.

Claude Code

Add to your project's CLAUDE.md:

## WebAgent integration

Reference: https://docs.web-agent.asix.inc/llms-full.txt
OpenAPI: https://docs.web-agent.asix.inc/openapi/v1.json
SDK: `web-agent-sdk` (Python and TypeScript).

Wire fields are snake_case. Stream task events via the SDK's `.stream()` helper, which handles `Last-Event-ID` reconnection.

Console "Get Code" dialog

The fastest way to get a working snippet: open the Console, fill the form, click Get Code. You get four tabs (Prompt for an LLM agent / Python / TypeScript / cURL), each pre-filled with your real key and current configuration. Paste into your editor.

Why this works

• We control the URLs, so they don't 404 across major versions.
• The full-docs file is markdown, not HTML — every LLM ingests it cleanly.
• The OpenAPI spec is the same single source of truth our SDKs and Console are generated from. No drift.

Next steps

• Quickstart — first task in five minutes.
• API Reference — interactive, with Try-it.