Skip to main content
POST
エージェントによるデータ抽出タスクを開始する
Firecrawl API キーが必要な AI エージェントの方は、自動オンボーディング手順について firecrawl.dev/agent-onboarding/SKILL.md を参照してください。

承認

Authorization
string
header
必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

ボディ

application/json
prompt
string
必須

抽出するデータ内容を指定するプロンプト

Maximum string length: 10000
auditMetadata
object

組織でSIEM Loggingが有効になっている場合、SIEMロギングイベントに含まれるユーザーの属性情報。

effort
enum<string>

エージェントタスクの推論予算。すべての実行は spark-2 で実行されるため、モデルの指定有無にかかわらず effort を送信できます。

利用可能なオプション:
low,
medium,
high
exchange
object

実行中に Agent が Team の Alexandria データプロバイダーを呼び出せるようにします。このオブジェクトを指定しない場合、ウェブのみを使用して実行します(追加ターンでは前のターンの設定を引き継ぎます)。接続済みの Alexandria ツールを使用するを参照してください。

maxCredits
number

このエージェントタスクで使用するクレジットの最大値です。未設定の場合、デフォルトは2500です。2,500を超える値は、常に有料リクエストとして課金されます。

mode
enum<string>
デフォルト:extract

extract は、各ターンで構造化された結果全体を data に返します。chat では、新しいデータを求めない追加リクエストに対して、再実行せずに message に短い回答を返せます。exchange.requireApproval を使用するには、同じリクエストで chat を指定する必要があります。追加ターンで省略すると、スレッドのモードが維持されます。

利用可能なオプション:
extract,
chat
model
enum<string>
デフォルト:spark-2

エージェントタスクで使用するモデルを指定します。spark-2 はデフォルトで、すべての実行で使用されるモデルです。Spark 1 のモデル名は後方互換性のため引き続き使用できますが、非推奨であり、spark-2 にルーティングされます。

利用可能なオプション:
spark-2,
spark-1-mini,
spark-1-pro
schema
object

抽出データを構造化するためのオプションの JSON スキーマ

strictConstrainToURLs
boolean

true の場合、エージェントは urls 配列で指定された URL にのみアクセスします

threadId
string<uuid>

既存のスレッドを続行するには、以前の実行で返された threadId を渡します。このリクエストは、そのスレッドの次のターンとして実行されます。省略した urls、schema、effort、mode、exchange の設定は、前のターンから引き継がれます。新しいスレッドを開始するには、threadId を省略します。

threatProtection
Threat Protection Override · object

このリクエスト単位の 脅威保護 オーバーライドです。指定したフィールドは、このリクエストに限り、組織のポリシー内の対応するフィールドを置き換えます。省略したフィールドには組織レベルの値がそのまま適用されます。利用するには、チームで脅威保護が有効になっている必要があります(エンタープライズ機能)。有効でない場合、リクエストは 403 で拒否されます。組織でリクエストごとのオーバーライドが無効になっている場合、このオブジェクトを含むリクエストはすべて 403 で拒否されます。チームに対して脅威保護が強制適用されている場合、mode に off は設定できません。

urls
string<uri>[]

エージェントのアクセス先を制限するための任意のURLリスト

webhook
object

webhook 仕様オブジェクト。エージェントのライフサイクルイベント(agent.started、agent.action、agent.completed、agent.failed、agent.cancelled)を購読します。

レスポンス

エージェントタスクが正常に開始されました

id
string<uuid>
success
boolean
threadId
string<uuid>

この実行が属するスレッド。スレッドを続行するには、これを threadId として渡します。

threadTurn
integer

スレッド内でのこの実行のターン番号。1 から始まります。