--- title: Crawl --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Browser Rendering](https://developers.cloudflare.com/api/typescript/resources/browser_rendering) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Crawl ##### [Crawl websites.](https://developers.cloudflare.com/api/typescript/resources/browser_rendering/subresources/crawl/methods/create) client.browserRendering.crawl.create(CrawlCreateParamsparams, RequestOptionsoptions?): [CrawlCreateResponse]() POST/accounts/{account\_id}/browser-rendering/crawl ##### [Get crawl result.](https://developers.cloudflare.com/api/typescript/resources/browser_rendering/subresources/crawl/methods/get) client.browserRendering.crawl.get(stringjobID, CrawlGetParams {account\_id, cacheTTL, cursor, 2 more } params, RequestOptionsoptions?): [CrawlGetResponse]() {id, browserSecondsUsed, finished, 5 more } GET/accounts/{account\_id}/browser-rendering/crawl/{job\_id} ##### [Cancel a crawl job.](https://developers.cloudflare.com/api/typescript/resources/browser_rendering/subresources/crawl/methods/delete) client.browserRendering.crawl.delete(stringjobID, CrawlDeleteParams {account\_id } params, RequestOptionsoptions?): [CrawlDeleteResponse]() {job\_id, message } DELETE/accounts/{account\_id}/browser-rendering/crawl/{job\_id} ##### ModelsExpand Collapse CrawlCreateResponse = string Crawl job ID. [Link to this property](<#(resource)%20browser_rendering.crawl%20%3E%20(model)%20crawl_create_response%20%3E%20(schema)>)
CrawlGetResponse {id, browserSecondsUsed, finished, 5 more } id: string Crawl job ID. Link to this property browserSecondsUsed: number Total seconds spent in browser so far. Link to this property finished: number Total number of URLs that have been crawled so far. Link to this property
records: Array<Record> List of crawl job records.
status: "queued"| "errored"| "completed"| 3 more Current status of the crawled URL. One of the following: "queued" Link to this property "errored" Link to this property "completed" Link to this property "disallowed" Link to this property "skipped" Link to this property "cancelled" Link to this property
Link to this property url: string Crawled URL. Link to this property html?: string HTML content of the crawled URL. Link to this property json?: Record<string, unknown> JSON of the content of the crawled URL. Link to this property markdown?: string Markdown of the content of the crawled URL. Link to this property
metadata?: Metadata {status, url, title } Absent for urls that never reached a fetch. status: number HTTP status code of the crawled page. Link to this property url: string Final URL of the crawled page. Link to this property title?: string Title of the crawled page. Link to this property
Link to this property
Link to this property skipped: number Total number of URLs that were skipped due to include/exclude/subdomain filters. Skipped URLs are included in records but are not counted toward total/finished. Link to this property status: string Current crawl job status. Link to this property total: number Total current number of URLs in the crawl job. Link to this property cursor?: string Cursor for pagination. Link to this property
[Link to this property](<#(resource)%20browser_rendering.crawl%20%3E%20(model)%20crawl_get_response%20%3E%20(schema)>)
CrawlDeleteResponse {job\_id, message } job\_id: string The ID of the cancelled job. Link to this property message: string Cancellation confirmation message. Link to this property
[Link to this property](<#(resource)%20browser_rendering.crawl%20%3E%20(model)%20crawl_delete_response%20%3E%20(schema)>)