OpenAPI Specification

Download the Chab API specification to import the current API into code generators, HTTP clients, and API testing tools. The OAuth device authorization specification covers CLI sign-in.

The OpenAPI 3.1 documents describe callable endpoints, required scopes, request and response fields, errors, and examples. The main API includes:

• Foundation endpoints, operations and estimates, and uploaded files.
• Search, SEO keywords, SEO domains, business discovery, and contacts.
• Scraping, screenshots, conversion, translation, model calls, and research.
• Mail and drive, including reads and supported mutations.
• Automation management, policies and audit, and webhooks.

Check each endpoint’s stability, live service health, and your plan’s capabilities before using it. All 19 provider operations in All tools are open to guests, free accounts and paid accounts. Each start still needs a healthy service, credits and the right access; a published schema does not mean provider work can start at a given moment. Connected-account Mail and Drive need a signed-in account and are not part of the free tools. Planned endpoints are excluded until published.

The Markdown reference explains usage, retries, credits, and setup. The OpenAPI documents provide the machine-readable contract for clients and tools. The main API spec also documents the guest trial bearer scheme and compatibility examples that expose free_credit_policy.monthly_refresh: false; free promotional credits are one-off grants and do not refresh monthly. The compatibility example includes hosted_mcp.guest_oauth_enabled; use the live GET /v1/cli/compatibility response before offering hosted guest authorization because it can be switched off separately from REST and local MCP access.