Skip to main content
POST
Run a project's modules now. Does not advance the schedule.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Path Parameters

projectId
string
required

Body

application/json

Which modules to run

Run a project's modules now. Runs in the background; read the results from the per-module routes once the run completes.

companyId
string
required

Company ID

modules
enum<string>[]

Only run these modules (enabled or not): keyword_research, domain_overview, opportunities, backlinks, link_profile, rank_tracking, competitors, ai_visibility, site_audit, lighthouse. Omit to run every enabled module.

Available options:
keyword_research,
domain_overview,
opportunities,
backlinks,
link_profile,
rank_tracking,
competitors,
ai_visibility,
site_audit,
lighthouse

Response

Run queued

The run was queued

success
boolean
queued
boolean
modules
string[]

Modules requested, or null for all enabled