Vibecoding with WebAgent

If you're writing code with an LLM in your IDE — Cursor, Claude Code, Aider, Continue, or another tool — add the complete WebAgent docs and OpenAPI schema to its context before asking it to implement an integration. This keeps the model from relying on stale knowledge or guessing fields.

Prepare the context

Site resource	Purpose	Recommended use
/en/webagent/llms.txt	Index of page titles and one-line descriptions	Let the model locate relevant pages first
/en/webagent/llms-full.txt	Complete documentation merged into one Markdown file	Download it or attach it as long-context input
/openapi/v1.json	OpenAPI 3.1 schema	Download it and use it as the authority for fields, requests, and responses

These resources use paths on the current documentation site and do not depend on a separate documentation domain. Before copying the rules below, open or download the resources you need and add them to the IDE session or project context.

Drop-in prompt

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

You are integrating WebAgent. Treat the complete WebAgent documentation and OpenAPI 3.1 schema I provide as authoritative. If the context does not define a required endpoint or field, identify the gap instead of guessing.

API conventions:
- Base URL: https://api.eak.eazo.ai
- 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.

Read the attached OpenAPI schema before writing code, then use the complete documentation to confirm the integration flow.

Cursor

.cursor/rules/webagent.md:

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

Read the complete documentation and OpenAPI schema provided with the project before writing WebAgent code.
Treat the OpenAPI schema as authoritative for fields, requests, and responses — never guess.
If the context does not define a required interface, ask before continuing.
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

Read the complete WebAgent documentation and OpenAPI schema attached to the project first.
SDK: `web-agent-sdk` (Python and TypeScript).

Treat the OpenAPI schema as authoritative for fields, requests, and responses. Wire fields are snake_case. Stream run events via the SDK's `.stream()` helper, which handles `Last-Event-ID` reconnection. If the context does not define a required interface, ask instead of guessing.

Refresh the context

When the WebAgent API or SDK version changes, download the complete documentation and OpenAPI schema again from the site resources on this page. Do not keep a retired external documentation domain in long-lived IDE rules.

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

• The documentation and schema travel with the project or session instead of depending on a fixed external documentation domain.
• The full-docs file is Markdown, not HTML, so LLMs can parse it directly.
• The OpenAPI spec is the same single source of truth our SDKs and Console are generated from. No drift.

Next steps

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