--- title: "Get all active crawls for the authenticated team" method: GET path: "/crawl/active" tags: ["Crawling"] --- # Get all active crawls for the authenticated team `GET /crawl/active` ## Response `200` Successful response - object - `success` boolean, required - `crawls` object[] - `id` string, uuid, required — The unique identifier of the crawl - `teamId` string, required — The ID of the team that owns the crawl - `url` string, uri, required — The origin URL of the crawl - `options` object, required — The crawler options used for this crawl - `scrapeOptions` ScrapeOptions - `formats` union[] — Output formats to include in the response. You can specify one or more formats, either as strings (e.g., `'markdown'`) or as objects with additional options (e.g., `{ type: 'json', schema: {...} }`). Some formats require specific options to be set. Example: `['markdown', { type: 'json', schema: {...} }]`. - union - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object — Extract audio (MP3) from supported video URLs, e.g. YouTube. Returns a signed GCS URL. - … - object — Extract best-quality video from supported video URLs, e.g. YouTube. Returns a signed GCS URL. - … - object — Ask a natural-language question about the page. Returns the answer in the response `answer` field. - … - object — Find relevant source text from the page. Returns the selected text in the response `highlights` field. - … - `onlyMainContent` boolean — Only return the main content of the page excluding headers, navs, footers, etc. This is a deterministic HTML-level filter applied before markdown is generated; no LLM is involved. - `onlyCleanContent` boolean — Beta. Run an additional LLM-based pass over the generated markdown to remove residual boilerplate that `onlyMainContent` can miss (cookie banners, ad blocks, social share widgets, breadcrumbs, newsletter signups, comment sections, related-article lists). Headings, lists, tables, code blocks, image references, and inline links are preserved. Can be combined with `onlyMainContent` (the most common setup) or used on its own. Skipped with a warning when the markdown exceeds the cleaning model's output token limit (the original markdown is preserved). Not supported on zero-data-retention requests. - `includeTags` string[] — Tags to include in the output. - `excludeTags` string[] — Tags to exclude from the output. - `maxAge` integer — Returns a cached version of the page if it is younger than this age in milliseconds. If a cached version of the page is older than this value, the page will be scraped. If you do not need extremely fresh data, enabling this can speed up your scrapes by 500%. Defaults to 2 days. - `minAge` integer — When set, the request only checks the cache and never triggers a fresh scrape. The value is in milliseconds and specifies the minimum age the cached data must be. If matching cached data exists, it is returned instantly. If no cached data is found, a 404 with error code SCRAPE_NO_CACHED_DATA is returned. Set to 1 to accept any cached data regardless of age. - `headers` object — Headers to send with the request. Can be used to send cookies, user-agent, etc. - `waitFor` integer — Specify a delay in milliseconds before fetching the content, allowing the page sufficient time to load. This waiting time is in addition to Firecrawl's smart wait feature. - `mobile` boolean — Set to true if you want to emulate scraping from a mobile device. Useful for testing responsive pages and taking mobile screenshots. - `skipTlsVerification` boolean — Skip TLS certificate verification when making requests. - `timeout` integer — Timeout in milliseconds for the request. Minimum is 1000 (1 second). Default is 60000 (60 seconds). Maximum is 300000 (300 seconds). - `parsers` object[] — Controls how files are processed during scraping. When "pdf" is included (default), the PDF content is extracted and converted to markdown format, with billing based on the number of pages (1 credit per page). When an empty array is passed, the PDF file is returned in base64 encoding with a flat rate of 1 credit for the entire PDF. - `type` 'pdf', required - `mode` 'fast' | 'auto' | 'ocr' — PDF parsing mode. "fast": text-based extraction only (embedded text, fastest). "auto" (default): attempts fast extraction first, falls back to OCR if needed. "ocr": forces OCR parsing on every page. - `maxPages` integer — Maximum number of pages to parse from the PDF. Must be a positive integer up to 10000. - `actions` union[] — Actions to perform on the page before grabbing the content - union - object - … - object - … - object - … - object - … - object - … - object — Press a key on the page. See https://asawicki.info/nosense/doc/devices/keyboard/key_codes.html for key codes. - … - object - … - object - … - object - … - object - … - `location` object — Location settings for the request. When specified, this will use an appropriate proxy if available and emulate the corresponding language and timezone settings. Defaults to 'US' if not specified. - `country` string — ISO 3166-1 alpha-2 country code (e.g., 'US', 'AU', 'DE', 'JP') - `languages` string[] — Preferred languages and locales for the request in order of priority. Defaults to the language of the specified location. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language - `removeBase64Images` boolean — Removes all base 64 images from the markdown output, which may be overwhelmingly long. This does not affect html or rawHtml formats. The image's alt text remains in the output, but the URL is replaced with a placeholder. - `blockAds` boolean — Enables ad-blocking and cookie popup blocking. - `proxy` 'basic' | 'enhanced' | 'auto' — Specifies the type of proxy to use. - **basic**: Proxies for scraping sites with none to basic anti-bot solutions. Fast and usually works. - **enhanced**: Enhanced proxies for scraping sites with advanced anti-bot solutions. Slower, but more reliable on certain sites. Costs up to 5 credits per request. - **auto**: Firecrawl will automatically retry scraping with enhanced proxies if the basic proxy fails. If the retry with enhanced is successful, 5 credits will be billed for the scrape. If the first attempt with basic is successful, only the regular cost will be billed. - `storeInCache` boolean — If true, the page will be stored in the Firecrawl index and cache. Setting this to false is useful if your scraping activity may have data protection concerns. Using some parameters associated with sensitive scraping (e.g. actions, headers) will force this parameter to be false. - `lockdown` boolean — If true, serves the request from Firecrawl's cache only and never makes an outbound request to the target URL. Designed for compliance-constrained or air-gapped environments where the scrape request itself could leak sensitive information. On cache miss, returns a 404 with error code SCRAPE_LOCKDOWN_CACHE_MISS (the URL is never logged on miss). Lockdown requests are treated as zero data retention. Default maxAge is extended to 2 years so existing cached pages remain eligible. Billed at 5 credits on hit, 1 credit on cache miss. - `redactPII` union — Redact personally identifiable information from returned markdown. Pass `true` to use defaults, or an object to tune mode, entities, and replacement style. - boolean - RedactPIIOptions — Tuning options for PII redaction. - `mode` 'accurate' | 'aggressive' | 'fast' — Redaction strategy. `accurate` is model-only and optimized for precision, `aggressive` increases recall with additional heuristics, and `fast` uses heuristics without the model call. - `entities` RedactPIIEntity[] — Restrict redaction to these entity buckets. If omitted, all supported entities are redacted. - `replaceStyle` 'tag' | 'mask' | 'remove' — `tag` replaces spans with placeholders like ``, `mask` replaces characters with `*`, and `remove` deletes the span text. - `profile` object — Enable persistent browser storage across scrape and interact sessions. Pass a profile when scraping to preserve cookies, localStorage, and session data. Sessions with the same profile name share browser state. - `name` string, required — A name for the profile. Scrapes with the same name share browser state (cookies, localStorage, sessions). - `saveChanges` boolean — When true, browser state is saved back to the profile when the interact session stops. Set to false to load existing data without writing. Only one saving session is allowed at a time. - `threatProtection` ThreatProtectionOverride — Per-request [Threat Protection](https://docs.firecrawl.dev/features/threat-protection) override. Fields you provide replace the corresponding fields of your organization's policy for this request only; omitted fields keep their organization-level values. Requires Threat Protection to be enabled for your team (enterprise feature) — otherwise the request is rejected with a 403. If your organization has disabled request overrides, any request that includes this object is rejected with a 403. If Threat Protection is enforced for your team, `mode` may not be set to `off`. - `mode` 'off' | 'normal' — URL scanning mode for this request. `normal` checks URLs against Google Web Risk (+2 credits per URL scanned). - `riskScoreThreshold` integer — Normalized risk score (0–100) at or above which a classifier verdict blocks the URL. Lower is stricter. - `blacklist` string[] — Domains to always block, as plain domains (`example.com`) or wildcard globs (`*.example.com`). No protocol, path, or port. - `whitelist` string[] — Domains to always allow, as plain domains or wildcard globs. Wins over every other rule. - `blockedTlds` string[] — Top-level domains to block outright, lowercase without the leading dot (e.g. `zip`). - `failurePolicy` 'open' | 'closed' — What to do when the classifier can't be reached: `closed` blocks the request, `open` allows it. ## Other responses - `402` — Payment required - `429` — Too many requests - `500` — Server error --- [API](https://skmtc.dev/firecrawl/apis/firecrawl-api.md) · [All operations](https://skmtc.dev/firecrawl/apis/firecrawl-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/firecrawl/firecrawl-api/revisions/e350fafb5a2a/schema)