获取 Agent 状态

获取智能体任务状态

curl --request GET \
  --url https://api.firecrawl.dev/v2/agent/{jobId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.firecrawl.dev/v2/agent/{jobId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.firecrawl.dev/v2/agent/{jobId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.firecrawl.dev/v2/agent/{jobId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.firecrawl.dev/v2/agent/{jobId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "creditsUsed": 123,
  "data": {},
  "effort": "low",
  "error": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "message": "<string>",
  "model": "spark-2",
  "partial": "<unknown>",
  "partialSchemaValid": true,
  "status": "processing",
  "stopReason": "credit_limit_reached",
  "success": true
}

{
  "error": "Invalid job ID format. Job ID must be a valid UUID."
}

{
  "error": "Agent job not found"
}

GET

agent

{jobId}

获取智能体任务状态

curl --request GET \
  --url https://api.firecrawl.dev/v2/agent/{jobId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.firecrawl.dev/v2/agent/{jobId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.firecrawl.dev/v2/agent/{jobId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.firecrawl.dev/v2/agent/{jobId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.firecrawl.dev/v2/agent/{jobId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "creditsUsed": 123,
  "data": {},
  "effort": "low",
  "error": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "message": "<string>",
  "model": "spark-2",
  "partial": "<unknown>",
  "partialSchemaValid": true,
  "status": "processing",
  "stopReason": "credit_limit_reached",
  "success": true
}

{
  "error": "Invalid job ID format. Job ID must be a valid UUID."
}

{
  "error": "Agent job not found"
}

如果你是需要 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.

路径参数

jobId

string<uuid>

必填

Agent 任务的 ID

响应

成功的响应

creditsUsed

number

data

object

提取的数据（仅在状态为 completed 时可用）。运行失败时不会设置此字段，包括因达到额度上限而停止的运行。

effort

enum<string>

代理运行使用的推理预算（仅存在于设置了 effort 的运行中）

可用选项:

low,

medium,

high

error

string

错误信息（仅当状态为失败时出现）

expiresAt

string<date-time>

message

string

代理对结果的说明。如果运行因达到额度上限而停止并失败，此说明可能会指出哪些内容尚未完成。

model

enum<string>

默认值:spark-2

本次代理运行所使用的模型预设。每次新运行均在 spark-2 上执行；Spark 1 名称仅会出现在旧版运行中。

可用选项:

spark-2,

spark-1-pro,

spark-1-mini

partial

any

从未完成的运行中尽力恢复的 JSON。仅在部分失败的运行中提供，例如达到 maxCredits 上限的运行；运行仍在处理时不会提供。其中可能缺少行或字段，因此请勿将其视为完整结果。

partialSchemaValid

boolean

partial 是否通过请求中指定的 JSON 模式验证。仅当 partial 存在且请求包含 schema 时提供。

status

enum<string>

可用选项:

processing,

completed,

failed

stopReason

enum<string>

运行失败并提前停止的原因。credit_limit_reached 表示运行已达到 maxCredits 上限。仅在状态为 failed 时提供。

可用选项:

credit_limit_reached

success

boolean

使用 API

搜索端点

抓取端点

交互 / 浏览器沙箱端点

研究索引端点

开发者索引端点

map端点

解析端点

爬取端点

监控端点

代理端点

反馈端点

代理式调试端点

账户端点

Webhook 负载

面向平台的 Firecrawl

授权

路径参数

响应