Skip to main content
POST
Iniciar uma tarefa de agente para extração de dados orientada a agentes
Você é um agente de IA que precisa de uma chave de API da Firecrawl? Veja firecrawl.dev/agent-onboarding/SKILL.md para instruções automatizadas de integração.

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
auditMetadata
object

Identificação do usuário incluída nos eventos de log do SIEM quando o SIEM Logging estiver habilitado para a organização.

effort
enum<string>

Orçamento de raciocínio para a tarefa do agente. Todas as execuções são realizadas no spark-2, portanto o esforço pode ser enviado com ou sem modelo.

Opções disponíveis:
low,
medium,
high
exchange
object

Permita que o agente chame os providers de dados da sua equipe no Alexandria durante a execução. Sem este object, a execução usa apenas a web (um turno de acompanhamento herda as configurações do turno anterior). Consulte Use suas ferramentas conectadas do Alexandria.

maxCredits
number

Máximo de créditos a serem gastos nesta tarefa do agente. O padrão é 2500 se não for definido. Valores acima de 2.500 são sempre cobrados como requisições pagas.

mode
enum<string>
padrão:extract

extract retorna o resultado estruturado completo em data a cada turno. chat permite responder a uma solicitação de acompanhamento que não peça novos dados com uma resposta curta em message, em vez de executar novamente. exchange.requireApproval exige chat na mesma solicitação. Se omitido em um turno de acompanhamento, o modo da conversa é mantido.

Opções disponíveis:
extract,
chat
model
enum<string>
padrão:spark-2

Modelo a ser usado na tarefa do agente. spark-2 é o padrão, e todas as execuções são realizadas nele. Os nomes de modelo Spark 1 continuam aceitos para compatibilidade retroativa, mas estão descontinuados e são direcionados para spark-2.

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

Esquema JSON opcional para estruturar os dados extraídos

strictConstrainToURLs
boolean

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

threadId
string<uuid>

Continue uma conversa existente: passe o threadId retornado por uma execução anterior para executar esta solicitação como o próximo turno dessa conversa. As configurações de urls, schema, effort, mode e exchange omitidas são herdadas do turno anterior. Omita threadId para iniciar uma nova conversa.

threatProtection
Threat Protection Override · object

Substituição por solicitação da Proteção contra ameaças. Os campos fornecidos substituem os campos correspondentes da política da sua organização apenas nesta solicitação; os campos omitidos mantêm os valores definidos no nível da organização. Exige que a Proteção contra ameaças esteja habilitada para sua equipe (recurso enterprise) — caso contrário, a solicitação será rejeitada com 403. Se sua organização tiver desativado substituições por solicitação, qualquer solicitação que inclua este objeto será rejeitada com 403. Se a Proteção contra ameaças for imposta à sua equipe, mode não poderá ser definido como off.

urls
string<uri>[]

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

webhook
object

Um objeto de especificação de webhook. Inscreve-se em eventos do ciclo de vida do agente (agent.started, agent.action, agent.completed, agent.failed, agent.cancelled).

Resposta

Tarefa do agente iniciada com sucesso

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

A conversa à qual esta execução pertence. Passe esse valor como threadId para continuar a conversa.

threadTurn
integer

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