Skip to content

v2

Status
Support
Sign Up

Documentation SDKs Integrations API Reference Build with AI

v2

Using the API

Introduction Errors

Search Endpoints

POSTSearch POSTSearch Feedback

Scrape Endpoints

POSTScrape POSTBatch Scrape GETGet Batch Scrape Status DELCancel Batch Scrape GETGet Batch Scrape Errors

Interact Endpoints

POSTCreate Interact Session POSTExecute Code in a Session GETList Interact Sessions DELDelete Interact Session POSTInteract with a Scraped Page DELStop Interacting

Research Index Endpoints

GETSearch Papers GETInspect or Read Paper GETFind Related Papers GETSearch GitHub History

Map Endpoints

Parse Endpoints

Crawl Endpoints

POSTCrawl GETGet Crawl Status POSTCrawl Params Preview DELCancel Crawl GETGet Crawl Errors GETGet Active Crawls

Monitor Endpoints

POSTCreate Monitor GETList Monitors GETGet Monitor PATCHUpdate Monitor DELDelete Monitor POSTRun Monitor GETList Monitor Checks GETGet Monitor Check

Feedback Endpoints

POSTEndpoint Feedback

Agentic Debugging Endpoints

POSTAsk POSTDocs Search

Account Endpoints

GETActivity GETCredit Usage GETHistorical Credit Usage GETToken Usage GETHistorical Token Usage GETQueue Status GETGet Threat Protection Policy PUTUpdate Threat Protection Policy

Webhook Payloads

Partner Integration

Partner Integration API

Scrape Endpoints

Get Batch Scrape Status

GET/batch/scrape/{id}

Are you an AI agent that needs a Firecrawl API key? See firecrawl.dev/agent-onboarding/SKILL.md for automated onboarding instructions.

Was this page helpful?Suggest edits Raise issue

PreviousBatch Scrape NextCancel Batch Scrape

For AI agents

Get credentials
Agent onboarding (SKILL.md)
Agent auth (auth.md)
Agent docs (llms.txt)
Full docs (llms-full.txt)
MCP server