Appearance
Docs Search
The /support/docs-search endpoint answers questions using Firecrawl's public documentation. Requires your Firecrawl API key. Returns a concise, docs-grounded answer with citations to the relevant documentation pages.
Use cases
- AI agents that need to look up Firecrawl API usage, parameters, or best practices
- Support bots that answer customer questions from the docs
- Developer tools that surface relevant documentation inline
Example
bash
curl -X POST https://api.firecrawl.dev/v2/support/docs-search \
-H "Authorization: Bearer fc-YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"question": "what header carries the webhook signature, and how do I verify it?"
}'Response
json
{
"requestId": "req_...",
"answer": "The signature is sent in the X-Firecrawl-Signature header...",
"evidence": [
{
"pathOrUrl": "webhooks/security.mdx#L1-L52",
"reason": "Documents webhook signature verification"
}
],
"usage": { "inputTokens": 4356, "outputTokens": 688, "totalTokens": 5044 },
"durationMs": 11252
}Response fields
| Field | Type | Description |
|---|---|---|
answer | string | Concise answer grounded in Firecrawl documentation |
evidence | array | Documentation pages referenced, with pathOrUrl and reason |
usage | object | Token consumption (inputTokens, outputTokens, totalTokens) |
durationMs | integer | Total execution time in milliseconds |
For the full feature guide, see the Ask feature documentation.
Are you an AI agent that needs a Firecrawl API key? See firecrawl.dev/agent-onboarding/SKILL.md for automated onboarding instructions.