Partner API

概要

Firecrawl パートナー連携APIを使うと、自社のバックエンドから直接、ユーザー向けのFirecrawl APIキーを作成・管理できます。ユーザーは自社プラットフォームを離れることなくFirecrawlを使い始められます。

パートナーAPIはFirecrawl ダッシュボードからご自身でセットアップできます。組織の管理者またはメンバーであれば誰でもインテグレーションを作成できます。名前を付け、セットアップを選択し、そのセットアップの規約に同意して、パートナーキーをコピーしてください。キーが表示されるのは一度だけです。キーの発行と失効は後からSettingsで行えます。申請や承認は不要です。

セットアップは2種類あります。どちらも以下のエンドポイントを通じて同じ方法でアカウントをプロビジョニングしますが、ユーザーの利用分を誰が支払うかが異なります。

Partner API: プロビジョニングされた各アカウントが独自のFirecrawl planと課金を持ちます。ユーザーはFree planから始め、Firecrawlと直接契約してupgradeします。
Gateway: インテグレーションで作成したアカウントはGatewayに登録され、ユーザー自身のクレジットを使い切った後の対象利用分は自社の組織に課金されます。GatewayのアカウントはAPI専用で、独自のdashboardログインはありません。

セットアップはインテグレーション作成時に選択します。後から変更するのは簡単ではないため、規約に同意する前に両方のオプションをよくご確認いただくことをおすすめします。概要についてはPartner APIページをご覧ください。一部のパートナーオファーには、プロビジョニングされたユーザー向けのプロモーションクレジットが含まれます。その場合、ユーザーが受け取る内容についてはPartner Creditsをご覧ください。

ベース URL

https://integrations.firecrawl.dev

認証

すべてのパートナー連携API リクエストには、パートナーキーを含む Authorization ヘッダーが必要です。

Authorization: Bearer <partner key>

パートナーキーは通常のFirecrawl APIキーとは異なります。Firecrawl ダッシュボードの設定 > Partner API で作成・失効できます。

セキュリティ要件

サーバーサイドのみ: パートナーキーは、サーバーサイドのコードでのみ使用してください。フロントエンドのコード、クライアントサイドの JavaScript、モバイルアプリケーションでは、パートナーキーを決して公開しないでください。
利用規約: POST /partner/v1/accounts を呼び出す前に、ユーザーに Firecrawl の利用規約への同意を求める必要があります。

エンドポイント

ユーザーを作成

メールアドレスで識別されるユーザー向けにFirecrawlアカウントをプロビジョニングし、そのAPIキーを返します。

POST /partner/v1/accounts

動作

Partner API セットアップの場合:

ユーザーがまだ Firecrawl アカウントを持っていない場合、新しいユーザーとチームが作成されます。
ユーザーがすでに Firecrawl アカウントを持っているものの、お客様の連携に紐づくチームがない場合、新たにパートナー紐付けチームが作成されます。
ユーザーがすでに Firecrawl アカウントを持ち、お客様の連携に紐づくチームもある場合は、既存のチームが返されます。

Gateway セットアップの場合:

アカウントはすべて、お客様の連携専用に作成されます。メールアドレスが一致する場合でも、リクエストが既存の Firecrawl アカウントに紐づけられることはありません。メールアドレスはアカウントの連絡先として保存されるだけで、アカウントの検索には使用されません。
同じメールアドレスで繰り返し呼び出した場合は、同じアカウントとそのAPIキーが返されます。

お客様の連携にプロモーションクレジットが含まれる場合は、アカウントの初回作成時に一度だけ付与されます。

リクエスト

cURL

curl -X POST "https://integrations.firecrawl.dev/partner/v1/accounts" \
  -H "Authorization: Bearer <partner key>" \
  -H "Content-Type: application/json" \
  -d '{"email": "user@example.com"}'

ボディ

フィールド	型	必須	説明
`email`	string	はい	ユーザーのメールアドレス。Gateway セットアップでは、アカウントの連絡先アドレスとして保存されます。

レスポンス

200 OK

{
  "apiKey": "fc-...",
  "alreadyExisted": false
}

Gateway セットアップの場合、レスポンスには登録 status も含まれます。

{
  "apiKey": "fc-...",
  "alreadyExisted": false,
  "gatewayStatus": "enrolled"
}

フィールド	型	説明
`apiKey`	string	このユーザーのパートナーに関連付けられたチームの Firecrawl APIキー
`alreadyExisted`	boolean	このメールアドレス向けのアカウントをお使いのインテグレーションがすでにプロビジョニング済みだった場合は `true`。Firecrawl の他の場所にそのメールアドレスが存在するかどうかは示しません。
`gatewayStatus`	string	Gateway連携のみ。アカウントを作成する呼び出しでは `enrolled`、同じメールアドレスに対する以降の呼び出しでは `already_enrolled` となります。

エラー

ステータス	説明
`400`	不正なリクエスト - `email` が未指定または形式が不正です
`401`	未認証 - パートナーキーが誤っているか無効です
`500`	内部サーバーエラー - これらのエラーは Firecrawl 側で監視されています

APIキーの検証

Firecrawl APIキーを検証し、関連するチーム名とユーザーのメールアドレスを返します。APIキーが有効と判定されるのは、このパートナー連携を通じて作成された場合に限られます。

POST /partner/v1/api-keys/validate

重要な注意点

Firecrawl APIキーには権限設定や有効期限がありません。
APIキーは、ユーザーがいつでも手動で削除できます。
削除されたAPIキーはソフトデリートされません。Firecrawlでは、削除されたキーと、そもそも存在しなかったキーを区別できません。

リクエスト

cURL

curl -X POST "https://integrations.firecrawl.dev/partner/v1/api-keys/validate" \
  -H "Authorization: Bearer <partner key>" \
  -H "Content-Type: application/json" \
  -d '{"apiKey": "fc-..."}'

ボディ

フィールド	型	必須	説明
`apiKey`	string	はい	検証対象の API キー

レスポンス

200 OK

{
  "teamName": "Example Team",
  "email": "user@example.com"
}

フィールド	タイプ	説明
`teamName`	string	このAPIキーに関連付けられたチーム名
`email`	string	アカウントの発行時に使用されたメールアドレス。Gatewayアカウントの場合は、ご提供いただいた連絡先アドレスです。

エラー

ステータス	説明
`400`	不正なリクエスト - APIキーの形式が誤っています
`401`	未認証 - パートナーキーが誤っているか無効です
`404`	APIキーを識別できません - キーが存在しないか、このパートナー連携経由で作成されたものではありません
`500`	内部サーバーエラー - これらのエラーは Firecrawl 側で監視されています

APIキーを再発行

既存のFirecrawl APIキーを削除し、同じユーザーとチーム向けに新しいキーを作成します。

POST /partner/v1/api-keys/rotate

リクエスト

cURL

curl -X POST "https://integrations.firecrawl.dev/partner/v1/api-keys/rotate" \
  -H "Authorization: Bearer <partner key>" \
  -H "Content-Type: application/json" \
  -d '{"apiKey": "fc-..."}'

ボディ

フィールド	型	必須	説明
`apiKey`	string	はい	削除して新しいものに置き換える API キー

レスポンス

200 OK

{
  "apiKey": "fc-..."
}

フィールド	型	説明
`apiKey`	string	新しく作成されたAPIキー

エラー

ステータス	説明
`401`	未認証 - パートナーキーが誤っているか無効です
`404`	API key を特定できません - キーが存在しないか、このパートナー連携経由で作成されていません
`500`	内部サーバーエラー - これらのエラーは Firecrawl 側で監視されています

はじめに

Firecrawl ダッシュボードでインテグレーションを作成します。サインインし、Partner API または Gateway を選択して規約に同意し、パートナーキーをコピーしてください。このセットアップは後から変更することが難しいため、規約に同意する前に選択内容をご確認ください。あとは、上記のエンドポイントをサーバーから呼び出すだけです。セットアップについてご質問がある場合は、help@firecrawl.com までご連絡ください。より大規模な連携をご検討中の場合は、partnerships@firecrawl.dev までご連絡ください。

API の利用方法

検索エンドポイント

スクレイピングエンドポイント

Interact / ブラウザサンドボックスエンドポイント

Research Index エンドポイント

Developer Indexエンドポイント

マップエンドポイント

解析エンドポイント

クロールエンドポイント

モニターエンドポイント

エージェントエンドポイント

フィードバックエンドポイント

エージェント型デバッグエンドポイント

アカウントエンドポイント

webhook ペイロード

パートナーAPI

概要

ベース URL

認証

セキュリティ要件

エンドポイント

ユーザーを作成

動作

リクエスト

レスポンス

エラー

APIキーの検証

重要な注意点

リクエスト

レスポンス

エラー

APIキーを再発行

リクエスト

レスポンス

エラー

はじめに

​概要

​ベース URL

​認証

​セキュリティ要件

​エンドポイント

​ユーザーを作成

​動作

​リクエスト

​レスポンス

​エラー

​APIキーの検証

​重要な注意点

​リクエスト

​レスポンス

​エラー

​APIキーを再発行

​リクエスト

​レスポンス

​エラー

​はじめに

概要

ベース URL

認証

セキュリティ要件

エンドポイント

ユーザーを作成

動作

リクエスト

レスポンス

エラー

APIキーの検証

重要な注意点

リクエスト

レスポンス

エラー

APIキーを再発行

リクエスト

レスポンス

エラー

はじめに