Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/firecrawl/firecrawl/llms.txt

Use this file to discover all available pages before exploring further.

GET /v1/crawl/active

Retrieve a list of all currently active crawl jobs for the authenticated team.

Authentication

This endpoint requires authentication using a Bearer token. Include your API key in the Authorization header:
Authorization: Bearer YOUR_API_KEY

Response

success
boolean
Indicates if the request was successful
crawls
array
Array of active crawl jobs. Each crawl object contains:

Example Request

curl -X GET https://api.firecrawl.dev/v1/crawl/active \
  -H 'Authorization: Bearer YOUR_API_KEY'

Example Response

{
  "success": true,
  "crawls": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "teamId": "team_abc123",
      "url": "https://example.com",
      "options": {
        "scrapeOptions": {
          "formats": ["markdown", "html"],
          "onlyMainContent": true
        }
      }
    },
    {
      "id": "234e5678-f90c-23e4-b567-537725285111",
      "teamId": "team_abc123",
      "url": "https://docs.example.com",
      "options": {
        "scrapeOptions": {
          "formats": ["markdown"],
          "onlyMainContent": true
        }
      }
    }
  ]
}

Error Responses

402 Payment Required
{
  "success": false,
  "error": "Payment required to access this resource."
}
429 Too Many Requests
{
  "success": false,
  "error": "Request rate limit exceeded. Please wait and try again later."
}
500 Server Error
{
  "success": false,
  "error": "An unexpected error occurred on the server."
}

Use Cases

  • Monitor all ongoing crawl operations for your team
  • Track resource usage across multiple crawls
  • Identify long-running crawls that may need attention
  • Manage concurrent crawl jobs
  • Audit crawl activity across your organization

Notes

  • Only returns crawls that are currently in progress (status: scraping)
  • Completed, failed, or cancelled crawls are not included
  • All team members with valid API keys can see the same active crawls
  • Use the crawl id to get detailed status with Get Crawl Status