Runtype APISelf Hosting

Execute a synchronous site crawl

Hosted fulfillment of the runtime SiteCrawler seam. Executes the same crawl capability the `crawl` flow step uses (Cloudflare Browser Rendering: submit, poll to completion, paginate results) and resolves once with the collected pages. Synchronous only: the async crawl_pending pause machinery is not available on this endpoint. Consumed by standalone `@runtypelabs/runtime` deployments via `HostedSiteCrawler`. Requires an Enterprise plan: ineligible accounts receive 403 (code `BYOC_PLAN_REQUIRED`).

Authentication

AuthorizationBearer
API key or Clerk session token

Request

This endpoint expects an object.
urlstringRequired>=1 character

Fully-resolved seed URL, passed through to the crawl service untouched. Note the platform crawl service drops query strings from the seed URL and follows absolute links only (service behavior, inherited by design).

limitsobjectOptional
optionsobjectOptional

Response

Crawl completed
metadataobject

Implementation metadata folded into the runtime step’s result metadata.

pageslist of objects

All collected result pages; the first entry is the terminal status page (the crawl step output’s result field).

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
501
Not Implemented Error
502
Bad Gateway Error
504
Gateway Timeout Error