List every SurfRank project (tracked website) the caller has access to. If the API key is scoped to a single project, only that one is returned.

Get a single project by its ID. Returns domain, brand, industry, and config.

Create a new tracked project. Requires domain (the root URL without scheme) and brandName. industry and country are optional but improve analysis quality.

Update an existing project. Pass only the fields you want to change.

Permanently delete a project and all of its keywords, reports, and analyses.

List all tracked keywords (prompts) for a project.

Add a single keyword (prompt) to a project. SurfRank will query every configured AI engine with this prompt on the next report run.

Add multiple keywords to a project in one call. Respects per-plan keyword caps.

Delete a single keyword from a project.

Queue a new AI-visibility report for a project. Cost: 0.3 credits × keywords × engines. Returns immediately with a job ID (202). Poll get_report or list_reports to check status.

List recent reports for a project (most recent first).

Get a single report by ID, including score, trends, and per-engine breakdowns.

Get the per-keyword analyses from the project's most recent completed report. Useful for inspecting which prompts mention the brand and which engines surfaced it.

Start a "quick test" — a low-cost (1 credit) AI-visibility snapshot for a domain. Returns immediately; the test runs asynchronously. Use get_quick_test to poll. If your API key is scoped to a project, websiteId must match that project.

List quick tests, optionally filtered by project.

Get a single quick test by ID, including status and results.

After a quick test reaches awaiting_keyword_selection, pick 1–5 keywords to analyse in depth. This kicks off the main analysis pass.

Research a keyword across every configured AI engine. Returns volume, intent, related prompts, and competitor mentions. Cost: ~0.5 credits × engines. If the API key is scoped to a project, websiteId must be passed and must match that scope.

List past keyword research runs, optionally filtered by project.

Get a single keyword-research run by ID.

List all tracked competitors for a project.

Add a competitor domain to a project for side-by-side visibility tracking.

Remove a competitor from a project.

List content / keyword opportunities flagged for a project — prompts where the brand is under-mentioned relative to competitors, ranked by expected impact.