Agente

POST /agent

Iniciar uma tarefa de agente para extração de dados orientada a agentes

cURL

curl --request POST \
  --url https://api.firecrawl.dev/v2/agent \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "<string>",
  "urls": [
    "<string>"
  ],
  "schema": {},
  "maxCredits": 123,
  "strictConstrainToURLs": true,
  "model": "spark-1-mini"
}
'

200

{
  "success": true,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Autorizações

Authorization · string · header · obrigatório

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

Corpo

application/json

prompt · string · obrigatório

O prompt que descreve quais dados devem ser extraídos

Maximum string length: 10000

urls · string<uri>[]

Lista opcional de URLs às quais o agente ficará restrito

schema · object

Esquema JSON opcional para estruturar os dados extraídos

maxCredits · number

Número máximo de créditos a serem usados nesta tarefa do agente. O valor padrão é 2500, caso não seja especificado.

strictConstrainToURLs · boolean

Se verdadeiro, o agente visitará somente as URLs fornecidas no array urls

model · enum<string> · padrão: spark-1-mini

Modelo a ser usado na tarefa do agente. spark-1-mini (padrão) é 60% mais barato; spark-1-pro oferece maior precisão em tarefas complexas.

Opções disponíveis: spark-1-mini, spark-1-pro

Resposta

200

application/json

Tarefa do agente iniciada com sucesso

success · boolean

id · string<uuid>