Introduction
Zawqi gives agents full-page captures, rendered HTML, Markdown, logos, and taxonomy through one stable Site API.
Zawqi agent API
Zawqi is an agent-native site-research product. It gives your agent full-page captures, rendered HTML, homepage and pricing Markdown, logos, Open Graph metadata, and industry taxonomy through one stable Site API.
This documentation is generated from the live Effect contract — the same source of truth that implements the routes. The API reference is produced from the published public boundary only, so it can never silently drift from what the server actually does, and it never shows internal surface.
- Site capability — read
/api/v1/site-capabilityfirst for the compact discovery document (versions, base URL, dynamic limits) before a task. - API reference — every public operation, schema, and error, generated from the contract.
- Site capability — read
/api/site-capabilityfirst for the compact discovery document (versions, base URL, dynamic limits) before a task. - Authentication — Site detail and search accept a
zawqi_live_…bearer token (create one from your profile). Public reads (Site listing, backers) need no token. - The skill — install the companion skill for a turn-key workflow:
npx skills add Fawwaz-2009/zawqi-skills --skill zawqi-site-research -g.