Firecrawl data contract | PatchOps Knowledge

Provenance

PublisherFirecrawl

API basehttps://api.firecrawl.dev/

Freshness & coverage

FreshnessFreshness not declared

GeographicNot declared

TemporalNot declared

AuthenticationCredentials required (API key)

Methods (7)

crawl

unknown

Start a crawl job for a URL with default /v1/crawl endpoint.

Required paramsurl

Entitiescrawl job

Input schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "examples": [
        "https://example.com"
      ]
    },
    "endpoint": {
      "type": "string"
    },
    "body": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "url"
  ]
}

scrape

unknown

Scrape content from a single URL using /v1/scrape.

Required paramsurl

Input schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "examples": [
        "https://example.com"
      ]
    },
    "endpoint": {
      "type": "string"
    },
    "body": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "url"
  ]
}

search

read

Search indexed web content using /v1/search.

Required paramsquery

Input schema

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "examples": [
        "permian basin production decline"
      ]
    },
    "endpoint": {
      "type": "string"
    },
    "body": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "query"
  ]
}

getJobStatus

read

Get status/details for a crawl job.

Required paramsjobId

Input schema

{
  "type": "object",
  "properties": {
    "jobId": {
      "type": "string",
      "examples": [
        "12345"
      ]
    },
    "endpoint": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "jobId"
  ]
}

queryFirecrawl

read

Generic Firecrawl request helper for custom endpoints.

Input schema

{
  "type": "object",
  "properties": {
    "method": {
      "type": "string",
      "examples": [
        "POST"
      ],
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "POST"
          ]
        },
        {
          "type": "string",
          "enum": [
            "PATCH"
          ]
        },
        {
          "type": "string",
          "enum": [
            "GET"
          ]
        },
        {
          "type": "string",
          "enum": [
            "PUT"
          ]
        }
      ]
    },
    "endpoint": {
      "type": "string",
      "examples": [
        "/v1/search"
      ]
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    },
    "body": {
      "type": "object"
    }
  },
  "additionalProperties": false
}

getCorvaDocsSitemapUrls

read

Crawl the developer docs sitemap at dc-docs.corva.ai and list its page URLs (Firecrawl).

Input schema

{
  "type": "object",
  "properties": {
    "docsBaseUrl": {
      "type": "string",
      "examples": [
        "https://dc-docs.corva.ai"
      ]
    },
    "sitemapPathOrUrl": {
      "type": "string"
    },
    "maxItems": {
      "type": "number",
      "examples": [
        200
      ]
    }
  },
  "additionalProperties": false
}

crawlCorvaDocs

unknown

Start Firecrawl job for Corva docs. Defaults to /docs/intro at safe depth.

Entitiescrawl job

Input schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string"
    },
    "endpoint": {
      "type": "string"
    },
    "body": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    },
    "maxDepth": {
      "type": "number"
    }
  },
  "additionalProperties": false
}