docs
Contents
Guides

Use the API

Run a free audit from your own code or agent, and read the result.

The API lives at https://use.webtick.app/api/v1 and is described by the OpenAPI document at /api/v1/openapi.json. Project endpoints use your signed-in session; the public audit endpoints need no key.

Start a free audit

POST /public/audits with JSON {"url": "https://example.com"} and an Idempotency-Key header of 16 to 128 characters. The 202 response carries audit_id, status_url and result_token. The endpoint is rate-limited per client.

Read the result

GET the status_url with Authorization: Bearer <result_token>. Poll until status is complete or failed; the report lists scores, checks and the agent readiness view.

API keys for project endpoints and the Webtick MCP server for your own agents are in progress (see MCP).

Next: Use cases