Firecrawl

opencollection: 1.0.0
info:
  name: Firecrawl API
  version: v2
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Scraping
    type: folder
  items:
  - info:
      name: Scrape a single URL and optionally extract information using an LLM
      type: http
    http:
      method: POST
      url: https://api.firecrawl.dev/v2/scrape
      body:
        type: json
        data: '{}'
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Scrape a single URL and optionally extract information using an LLM
  - info:
      name: Interact with the browser session associated with a scrape job
      type: http
    http:
      method: POST
      url: https://api.firecrawl.dev/v2/scrape/:jobId/interact
      params:
      - name: jobId
        value: ''
        type: path
        description: The scrape job ID
      body:
        type: json
        data: '{}'
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Interact with the browser session associated with a scrape job
  - info:
      name: Stop the interactive browser session associated with a scrape job
      type: http
    http:
      method: DELETE
      url: https://api.firecrawl.dev/v2/scrape/:jobId/interact
      params:
      - name: jobId
        value: ''
        type: path
        description: The scrape job ID
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Stop the interactive browser session associated with a scrape job
  - info:
      name: Upload and parse a file
      type: http
    http:
      method: POST
      url: https://api.firecrawl.dev/v2/parse
      body:
        type: multipart-form
        data:
        - name: file
          type: text
          value: ''
        - name: options
          type: text
          value: ''
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Upload and parse a file
  - info:
      name: Scrape multiple URLs and optionally extract information using an LLM
      type: http
    http:
      method: POST
      url: https://api.firecrawl.dev/v2/batch/scrape
      body:
        type: json
        data: '{}'
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Scrape multiple URLs and optionally extract information using an LLM
  - info:
      name: Get the status of a batch scrape job
      type: http
    http:
      method: GET
      url: https://api.firecrawl.dev/v2/batch/scrape/:id
      params:
      - name: id
        value: ''
        type: path
        description: The ID of the batch scrape job
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Get the status of a batch scrape job
  - info:
      name: Cancel a batch scrape job
      type: http
    http:
      method: DELETE
      url: https://api.firecrawl.dev/v2/batch/scrape/:id
      params:
      - name: id
        value: ''
        type: path
        description: The ID of the batch scrape job
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Cancel a batch scrape job
  - info:
      name: Get the errors of a batch scrape job
      type: http
    http:
      method: GET
      url: https://api.firecrawl.dev/v2/batch/scrape/:id/errors
      params:
      - name: id
        value: ''
        type: path
        description: The ID of the batch scrape job
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Get the errors of a batch scrape job
- info:
    name: Crawling
    type: folder
  items:
  - info:
      name: Get the status of a crawl job
      type: http
    http:
      method: GET
      url: https://api.firecrawl.dev/v2/crawl/:id
      params:
      - name: id
        value: ''
        type: path
        description: The ID of the crawl job
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Get the status of a crawl job
  - info:
      name: Cancel a crawl job
      type: http
    http:
      method: DELETE
      url: https://api.firecrawl.dev/v2/crawl/:id
      params:
      - name: id
        value: ''
        type: path
        description: The ID of the crawl job
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Cancel a crawl job
  - info:
      name: Get the errors of a crawl job
      type: http
    http:
      method: GET
      url: https://api.firecrawl.dev/v2/crawl/:id/errors
      params:
      - name: id
        value: ''
        type: path
        description: The ID of the crawl job
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Get the errors of a crawl job
  - info:
      name: Crawl multiple URLs based on options
      type: http
    http:
      method: POST
      url: https://api.firecrawl.dev/v2/crawl
      body:
        type: json
        data: '{}'
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Crawl multiple URLs based on options
  - info:
      name: Preview crawl parameters generated from natural language prompt
      type: http
    http:
      method: POST
      url: https://api.firecrawl.dev/v2/crawl/params-preview
      body:
        type: json
        data: '{}'
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Preview crawl parameters generated from natural language prompt
  - info:
      name: Get all active crawls for the authenticated team
      type: http
    http:
      method: GET
      url: https://api.firecrawl.dev/v2/crawl/active
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Get all active crawls for the authenticated team
- info:
    name: Mapping
    type: folder
  items:
  - info:
      name: Map multiple URLs based on options
      type: http
    http:
      method: POST
      url: https://api.firecrawl.dev/v2/map
      body:
        type: json
        data: '{}'
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Map multiple URLs based on options
- info:
    name: Extraction
    type: folder
  items:
  - info:
      name: Extract structured data from pages using LLMs
      type: http
    http:
      method: POST
      url: https://api.firecrawl.dev/v2/extract
      body:
        type: json
        data: '{}'
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Extract structured data from pages using LLMs
  - info:
      name: Get the status of an extract job
      type: http
    http:
      method: GET
      url: https://api.firecrawl.dev/v2/extract/:id
      params:
      - name: id
        value: ''
        type: path
        description: The ID of the extract job
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Get the status of an extract job
- info:
    name: Agent
    type: folder
  items:
  - info:
      name: Start an agent task for agentic data extraction
      type: http
    http:
      method: POST
      url: https://api.firecrawl.dev/v2/agent
      body:
        type: json
        data: '{}'
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Start an agent task for agentic data extraction
  - info:
      name: Get the status of an agent job
      type: http
    http:
      method: GET
      url: https://api.firecrawl.dev/v2/agent/:jobId
      params:
      - name: jobId
        value: ''
        type: path
        description: The ID of the agent job
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Get the status of an agent job
  - info:
      name: Cancel an agent job
      type: http
    http:
      method: DELETE
      url: https://api.firecrawl.dev/v2/agent/:jobId
      params:
      - name: jobId
        value: ''
        type: path
        description: The ID of the agent job
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Cancel an agent job
- info:
    name: Billing
    type: folder
  items:
  - info:
      name: Get remaining credits for the authenticated team
      type: http
    http:
      method: GET
      url: https://api.firecrawl.dev/v2/team/credit-usage
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Get remaining credits for the authenticated team
  - info:
      name: Get historical credit usage for the authenticated team
      type: http
    http:
      method: GET
      url: https://api.firecrawl.dev/v2/team/credit-usage/historical
      params:
      - name: byApiKey
        value: ''
        type: query
        description: Get historical credit usage by API key
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Get historical credit usage for the authenticated team
  - info:
      name: Get remaining tokens for the authenticated team (Extract only)
      type: http
    http:
      method: GET
      url: https://api.firecrawl.dev/v2/team/token-usage
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Get remaining tokens for the authenticated team (Extract only)
  - info:
      name: Get historical token usage for the authenticated team (Extract only)
      type: http
    http:
      method: GET
      url: https://api.firecrawl.dev/v2/team/token-usage/historical
      params:
      - name: byApiKey
        value: ''
        type: query
        description: Get historical token usage by API key
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Get historical token usage for the authenticated team (Extract only)
- info:
    name: Miscellaneous
    type: folder
  items:
  - info:
      name: Metrics about your team's scrape queue
      type: http
    http:
      method: GET
      url: https://api.firecrawl.dev/v2/team/queue-status
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Metrics about your team's scrape queue
- info:
    name: Account
    type: folder
  items:
  - info:
      name: List recent API activity
      type: http
    http:
      method: GET
      url: https://api.firecrawl.dev/v2/team/activity
      params:
      - name: endpoint
        value: ''
        type: query
        description: Filter by endpoint
      - name: limit
        value: ''
        type: query
        description: Maximum number of results per page
      - name: cursor
        value: ''
        type: query
        description: Cursor for pagination. Use the cursor value from the previous response.
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Lists your team's recent API activity from the last 24 hours. Returns metadata about each job including the job
      ID, which can be used with the corresponding GET endpoint (e.g. GET /crawl/{id}) to retrieve full results. Supports
      cursor-based pagination and filtering by endpoint.
- info:
    name: Search
    type: folder
  items:
  - info:
      name: Search and optionally scrape search results
      type: http
    http:
      method: POST
      url: https://api.firecrawl.dev/v2/search
      body:
        type: json
        data: '{}'
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Search and optionally scrape search results
- info:
    name: Browser
    type: folder
  items:
  - info:
      name: List browser sessions
      type: http
    http:
      method: GET
      url: https://api.firecrawl.dev/v2/browser
      params:
      - name: status
        value: ''
        type: query
        description: Filter sessions by status
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: List browser sessions
  - info:
      name: Create a browser session
      type: http
    http:
      method: POST
      url: https://api.firecrawl.dev/v2/browser
      body:
        type: json
        data: '{}'
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Create a browser session
  - info:
      name: Execute code in a browser session
      type: http
    http:
      method: POST
      url: https://api.firecrawl.dev/v2/browser/:sessionId/execute
      params:
      - name: sessionId
        value: ''
        type: path
        description: The browser session ID
      body:
        type: json
        data: '{}'
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Execute code in a browser session
  - info:
      name: Delete a browser session
      type: http
    http:
      method: DELETE
      url: https://api.firecrawl.dev/v2/browser/:sessionId
      params:
      - name: sessionId
        value: ''
        type: path
        description: The browser session ID
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Delete a browser session
bundled: true