Obter status do agente

Obter o status de um job de agente

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>",
  "exchange": {
    "creditsUsed": 123,
    "enabled": true,
    "onTermsRequired": "skip",
    "paidCalls": 123,
    "requireApproval": true,
    "requiresAction": {
      "approvalId": "<string>",
      "providers": [
        {
          "accept": {},
          "adds": "<string>",
          "capability": "<string>",
          "digest": "<string>",
          "name": "<string>",
          "provider": "<string>",
          "show": {},
          "url": "<string>",
          "version": "<string>"
        }
      ],
      "type": "accept_terms"
    },
    "skippedProviders": [
      {
        "adds": "<string>",
        "capability": "<string>",
        "name": "<string>",
        "provider": "<string>",
        "reason": "terms_required",
        "termsUrl": "<string>",
        "version": "<string>"
      }
    ],
    "toolkits": [
      "<string>"
    ]
  },
  "expiresAt": "2023-11-07T05:31:56Z",
  "message": "<string>",
  "mode": "extract",
  "model": "spark-2",
  "partial": "<unknown>",
  "partialSchemaValid": true,
  "pendingApproval": {
    "calls": [
      {
        "capability": "<string>",
        "creditsEstimate": 123,
        "id": "<string>",
        "input": {},
        "more": [
          {}
        ],
        "provider": "<string>"
      }
    ],
    "id": "<string>",
    "kind": "calls",
    "reason": "<string>",
    "resolution": {
      "always": true,
      "approved": true,
      "byRunId": "<string>",
      "callIds": [
        "<string>"
      ]
    },
    "terms": [
      {
        "adds": "<string>",
        "capability": "<string>",
        "digest": "<string>",
        "name": "<string>",
        "provider": "<string>",
        "url": "<string>",
        "version": "<string>"
      }
    ]
  },
  "status": "processing",
  "stopReason": "credit_limit_reached",
  "success": true,
  "suggestions": [
    {
      "label": "<string>",
      "prompt": "<string>"
    }
  ],
  "threadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "threadTurn": 123
}

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

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

GET

agent

{jobId}

Obter o status de um job de agente

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>",
  "exchange": {
    "creditsUsed": 123,
    "enabled": true,
    "onTermsRequired": "skip",
    "paidCalls": 123,
    "requireApproval": true,
    "requiresAction": {
      "approvalId": "<string>",
      "providers": [
        {
          "accept": {},
          "adds": "<string>",
          "capability": "<string>",
          "digest": "<string>",
          "name": "<string>",
          "provider": "<string>",
          "show": {},
          "url": "<string>",
          "version": "<string>"
        }
      ],
      "type": "accept_terms"
    },
    "skippedProviders": [
      {
        "adds": "<string>",
        "capability": "<string>",
        "name": "<string>",
        "provider": "<string>",
        "reason": "terms_required",
        "termsUrl": "<string>",
        "version": "<string>"
      }
    ],
    "toolkits": [
      "<string>"
    ]
  },
  "expiresAt": "2023-11-07T05:31:56Z",
  "message": "<string>",
  "mode": "extract",
  "model": "spark-2",
  "partial": "<unknown>",
  "partialSchemaValid": true,
  "pendingApproval": {
    "calls": [
      {
        "capability": "<string>",
        "creditsEstimate": 123,
        "id": "<string>",
        "input": {},
        "more": [
          {}
        ],
        "provider": "<string>"
      }
    ],
    "id": "<string>",
    "kind": "calls",
    "reason": "<string>",
    "resolution": {
      "always": true,
      "approved": true,
      "byRunId": "<string>",
      "callIds": [
        "<string>"
      ]
    },
    "terms": [
      {
        "adds": "<string>",
        "capability": "<string>",
        "digest": "<string>",
        "name": "<string>",
        "provider": "<string>",
        "url": "<string>",
        "version": "<string>"
      }
    ]
  },
  "status": "processing",
  "stopReason": "credit_limit_reached",
  "success": true,
  "suggestions": [
    {
      "label": "<string>",
      "prompt": "<string>"
    }
  ],
  "threadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "threadTurn": 123
}

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

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

Você é um agente de IA que precisa de uma chave de API do Firecrawl? Consulte firecrawl.dev/agent-onboarding/SKILL.md para ver instruções automatizadas de onboarding.

Autorizações

Authorization

string

header

obrigatório

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

Parâmetros de caminho

jobId

string<uuid>

obrigatório

O ID da tarefa do agente

Resposta

Resposta bem-sucedida

creditsUsed

number

data

object

Os dados extraídos (apenas presentes quando o status é "completed"). Nunca definidos em uma execução que falhou, inclusive quando ela foi interrompida ao atingir o limite de créditos.

effort

enum<string>

Orçamento de raciocínio usado na execução do agente (presente apenas em execuções que definem esforço)

Opções disponíveis:

low,

medium,

high

error

string

Mensagem de erro (apenas quando o status for "failed")

exchange

object

O que a execução fez com Alexandria. toolkits e requireApproval são os valores efetivos da execução após aplicar as configurações herdadas da conversa.

Show child attributes

expiresAt

string<date-time>

message

string

Uma observação do agente sobre o resultado. No modo chat, uma solicitação de acompanhamento que não peça novos dados recebe uma resposta aqui, e não em data. Se a execução falhou ao ser interrompida por atingir o limite de créditos, pode explicar o que ficou incompleto.

mode

enum<string>

Opções disponíveis:

extract,

chat

model

enum<string>

padrão:spark-2

Predefinição de modelo usada na execução do agente. Todas as novas execuções são realizadas no spark-2; os nomes do Spark 1 aparecem apenas em execuções legadas.

Opções disponíveis:

spark-2,

spark-1-pro,

spark-1-mini

partial

any

JSON recuperado, na medida do possível, de uma execução incompleta. Presente apenas em algumas execuções que falharam, como uma que atingiu maxCredits; nunca presente enquanto a execução está em processamento. Pode conter linhas ou campos faltantes, portanto não o trate como um resultado completo.

partialSchemaValid

boolean

Indica se partial é válido segundo o schema JSON da solicitação. Presente apenas quando há um partial e a solicitação incluiu um schema.

pendingApproval

object

A pergunta que interrompeu o turno. Responda no próximo turno da conversa com exchange.approve ou exchange.decline.

Show child attributes

status

enum<string>

Opções disponíveis:

processing,

completed,

failed

stopReason

enum<string>

Motivo pelo qual uma execução que falhou foi interrompida antes do término. credit_limit_reached significa que a execução atingiu o limite definido em maxCredits. Presente apenas quando o status é failed.

Opções disponíveis:

credit_limit_reached

success

boolean

suggestions

object[]

Sugestões de acompanhamento que o agente oferece para o próximo turno da conversa.

Show child attributes

threadId

string<uuid>

A conversa à qual esta execução pertence.

threadTurn

integer

O turno desta execução na conversa, com numeração a partir de 1.

Usando a API

Endpoints de busca

Endpoints /scrape

Endpoints para interagir / Browser Sandbox

Endpoints do Research Index

Endpoints do índice para desenvolvedores

Endpoints do índice governamental

Endpoints de mapeamento

Endpoints de Parse

Endpoints de rastreamento

Endpoints de monitoramento

Endpoints de agente

Endpoints de feedback

Endpoints de depuração agêntica

Endpoints da conta

Payloads de webhook

Firecrawl for Platforms

Autorizações

Parâmetros de caminho

Resposta