Skip to main content
The GEO Assets generation endpoint accepts your website URL and kicks off an asynchronous 4-stage pipeline — Page Discovery, Content Crawl, Enhanced Asset Generation, and Final Report. Because the job can take several minutes, the endpoint returns immediately with a jobId. You then poll the status endpoint until the job is completed, then fetch the generated files.
This endpoint deducts 20 credits from your account when the job starts. Ensure your balance is sufficient before calling it.

Start a generation job

Request body

string
required
The root URL of the website to crawl and generate GEO files for. Must include the protocol (e.g. https://yoursite.com).

Response

string
Unique identifier for this generation job. Use it to poll status and retrieve results.
string
Initial job state — always "queued" on a successful submission.

Poll for job status

Use GET /api/geo-assets/job/:jobId/status to check progress. Poll every 5–10 seconds until status is "completed" or "failed".

Status response

string
One of "queued", "processing", "completed", or "failed".
number
Completion percentage from 0 to 100.
string
Current pipeline stage: "discovering", "crawling", "generating", or "complete".

Generated files

When the job completes, seven files are available via the reports endpoints:

Error responses