Sitemap

Approve a sitemap quote and start the crawl

Approve a quoted sitemap job and start the crawl. The estimated cost is held against your balance and settled when the job finishes. Call it after createSitemapJob, within one hour; expired quotes are failed and cannot be approved. Also served under /map with the same shapes.

post/sitemap/{jobId}/approve

Request

  • Base URL: https://request.usestring.ai/v1
  • URL: https://request.usestring.ai/v1/sitemap/{jobId}/approve
  • Auth: HTTP bearer

Response

Job already in a terminal state; returns its current status (for example failed for an expired quote).

jobIdstring required
status'awaiting_approval' | 'running' | 'completed' | 'failed' | 'canceled' | 'token_cap_exceeded' required

Job status.

estimatedCostUsdstring

Quoted cost in USD, as a decimal string.

pendinginteger

Queued URLs.

processedinteger

URLs crawled so far.

pagesProcessedinteger
errorMessagestring

Why the job failed, for example quote_expired.

finishedAtstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.