Documentation Index
Fetch the complete documentation index at: https://docs.firecrawl.dev/llms.txt
Use this file to discover all available pages before exploring further.
Firecrawl /support/ask は、APIとして提供されるAIサポートエージェントです。問題を説明すると、検証済みの診断結果と、すぐに使える修正パラメータが返されます。通常は15〜30秒で応答します。
/support/ask は、あなたのエージェントのために待機するシニアFirecrawlエンジニアのようなものです。
Ask API は主に AIエージェントからの呼び出し を想定して設計されています。Firecrawl をスクレイピング、クロール、またはデータ抽出に使うエージェントを構築している場合は、自律的な問題解決のために /support/ask をエラーハンドリングフローに組み込んでください。
| エンドポイント | 認証 | 対象 | できること |
|---|
POST /support/ask | お使いのFirecrawl APIキー | エージェントとアプリ | チームのスコープ内で完全な診断ループを実行 |
POST /support/docs-search | お使いのFirecrawl APIキー | エージェントとアプリ | Firecrawlの公開ドキュメントに基づく回答を返す |
curl -X POST https://api.firecrawl.dev/v2/support/ask \
-H "Authorization: Bearer fc-YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"question": "my crawl returned 3 pages but I expected 50"
}'
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": "how do I set up webhook signature verification?"
}'
/support/ask を呼び出すと、AI エージェントは次の処理を行います。
- 証拠を収集 — ジョブのログ、アカウントの状態、クレジットの使用状況、関連ドキュメントを並行して調べます
- 問題を診断 — 集めた証拠全体をもとに推論し、根本原因を特定します
- 修正を提案 — 次回の API 呼び出しに直接適用できる、機械処理可能な
fixParameters を生成します
- 修正を検証 — 可能な場合は、実際の Firecrawl API に対して修正をテストし (例: パラメータを調整してスクレイピングを再試行) 、結果を報告します
重要な設計パターン: Firecrawl API の呼び出しが失敗したり、想定外の結果が返ってきたりした場合は、/support/ask を呼び出し、その後 fixParameters を使って再試行します。
import requests
FIRECRAWL_API_KEY = "fc-YOUR_API_KEY"
def diagnose_firecrawl_issue(question, rationale=None):
"""Call the Firecrawl Ask API to debug an issue."""
payload = {"question": question}
if rationale:
payload["rationale"] = rationale
response = requests.post(
"https://api.firecrawl.dev/v2/support/ask",
headers={
"Authorization": f"Bearer {FIRECRAWL_API_KEY}",
"Content-Type": "application/json",
},
json=payload,
)
return response.json()
# 例: 空のコンテンツを返したスクレイピングをデバッグする
result = diagnose_firecrawl_issue(
question="scrape returned empty markdown for https://example.com",
rationale="user needs product pricing data for competitive analysis",
)
print(result["answer"])
print(result["fixParameters"]) # 例: {"waitFor": 5000, "actions": [...]}
print(result["confidence"]) # "high"、"medium"、または "low"
async function diagnoseFirecrawlIssue(question, rationale) {
const response = await fetch(
"https://api.firecrawl.dev/v2/support/ask",
{
method: "POST",
headers: {
Authorization: `Bearer ${process.env.FIRECRAWL_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({ question, rationale }),
}
);
return response.json();
}
// 例: 途中で停止したクロールをデバッグする
const result = await diagnoseFirecrawlIssue(
"my crawl returned 3 pages but I expected 50",
"user is on their third failed crawl attempt today"
);
console.log(result.answer);
console.log(result.fixParameters);
from firecrawl import Firecrawl
client = Firecrawl(api_key="fc-YOUR_API_KEY")
# ステップ1: スクレイピングを試みる
doc = client.scrape("https://example.com/pricing", formats=["markdown"])
if not doc.markdown or len(doc.markdown) < 100:
# ステップ2: デバッグの支援を求める
diagnosis = diagnose_firecrawl_issue(
question=f"scrape returned only {len(doc.markdown or '')} chars of markdown for https://example.com/pricing",
)
# ステップ3: 修正パラメータを適用して再試行する
if diagnosis.get("fixParameters"):
doc = client.scrape(
"https://example.com/pricing",
formats=["markdown"],
**diagnosis["fixParameters"],
)
| パラメータ | 型 | 必須 | 説明 |
|---|
question | string | はい | デバッグしたい内容 (1〜8,000文字) |
rationale | string | いいえ | AI 呼び出し元に推奨。エンドユーザーが何を達成しようとしているかを示します。証拠収集の優先順位付けに役立ちます。 |
context | object | いいえ | エージェントからの任意形式のメタデータ。デバッグ用promptに含まれます |
| パラメータ | 型 | 必須 | 説明 |
|---|
question | string | はい | 回答対象の質問 (1〜8,000文字) |
{
"requestId": "req_...",
"answer": "<2-4 sentence prose diagnosis of the issue plus the recommended fix.>",
"confidence": "high",
"fixParameters": { "<param>": "<value>" },
"validation": {
"tested": true,
"result": "success",
"evidence": "<short summary of the validation tool call the agent ran to confirm the fix>"
},
"feedback": null,
"durationMs": 18432
}
実際のanswer、fixParameters、validation.evidenceは、各リクエストについて、実行内容に応じてエージェントが生成します。上記の例は実際の診断結果ではなく、レスポンスの形式を示したものです。
/support/docs-search のレスポンス
{
"requestId": "req_...",
"answer": "The signature is sent in the X-Firecrawl-Signature header...",
"evidence": [
{ "pathOrUrl": "webhooks/security.mdx#L1-L52", "reason": "..." }
],
"usage": { "inputTokens": 4356, "outputTokens": 688, "totalTokens": 5044 },
"durationMs": 11252
}
| 指標 | 一般的 | 最大 |
|---|
| レイテンシ | 15〜30秒 | 60秒 (厳密な上限) |
フィードバックやサポートが必要な場合は、help@firecrawl.com までメールでご連絡ください。
Firecrawl APIキーが必要なAIエージェントですか?自動オンボーディング手順については、firecrawl.dev/agent-onboarding/SKILL.md をご覧ください。