Get Agent Status

Get the status of an agent job

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

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

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

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

GET

agent

{jobId}

Get the status of an agent job

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

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

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

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

Are you an AI agent that needs a Firecrawl API key? See firecrawl.dev/agent-onboarding/SKILL.md for automated onboarding instructions.

Authorizations

Authorization

string

header

required

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

Path Parameters

jobId

string<uuid>

required

The ID of the agent job

Response

Successful response

success

boolean

status

enum<string>

Available options:

processing,

completed,

failed

data

object

The extracted data (only present when status is completed). Never set on a failed run, including one that stopped at its credit limit.

partial

any

Best-effort JSON recovered from an incomplete run. Only present on some failed runs, such as one that reached maxCredits; never present while the run is processing. It may be missing rows or fields, so do not treat it as a completed result.

partialSchemaValid

boolean

Whether partial validates against the request's JSON schema. Only present when partial is present and the request included a schema.

stopReason

enum<string>

Why a failed run stopped early. credit_limit_reached means the run hit its maxCredits limit. Only present when status is failed.

Available options:

credit_limit_reached

message

string

A note from the agent about the result. On a failed credit-limit stop, it may explain what is incomplete.

model

enum<string>

default:spark-2

Model preset used for the agent run. Every new run executes on spark-2; Spark 1 names only appear on legacy runs.

Available options:

spark-2,

spark-1-pro,

spark-1-mini

effort

enum<string>

Reasoning budget used for the agent run (only present for runs that set effort)

Available options:

low,

medium,

high

error

string

Error message (only present when status is failed)

expiresAt

string<date-time>

creditsUsed

number

Using the API

Search Endpoints

Scrape Endpoints

Interact / Browser Sandbox Endpoints

Research Index Endpoints

Developer Index Endpoints

Map Endpoints

Parse Endpoints

Crawl Endpoints

Monitor Endpoints

Agent Endpoints

Feedback Endpoints

Agentic Debugging Endpoints

Account Endpoints

Webhook Payloads

Firecrawl for Platforms

Authorizations

Path Parameters

Response