> ## Documentation Index
> Fetch the complete documentation index at: https://firecrawl-capy-docs-factual-copy-fixes.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Obter status do agente

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


## OpenAPI

````yaml pt-BR/api-reference/v2-openapi.json GET /agent/{jobId}
openapi: 3.0.0
info:
  contact:
    email: support@firecrawl.dev
    name: Firecrawl Support
    url: https://firecrawl.dev/support
  description: >-
    API para interagir com os serviços do Firecrawl e executar tarefas de web
    scraping e crawling.
  title: Firecrawl API
  version: v2
servers:
  - url: https://api.firecrawl.dev/v2
security:
  - bearerAuth: []
paths:
  /agent/{jobId}:
    parameters:
      - description: O ID da tarefa do agente
        in: path
        name: jobId
        required: true
        schema:
          format: uuid
          type: string
    get:
      tags:
        - Agent
      summary: Obter o status de um job de agente
      operationId: getAgentStatus
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  creditsUsed:
                    type: number
                  data:
                    description: >-
                      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.
                    type: object
                  effort:
                    description: >-
                      Orçamento de raciocínio usado na execução do agente
                      (presente apenas em execuções que definem esforço)
                    enum:
                      - low
                      - medium
                      - high
                    type: string
                  error:
                    description: Mensagem de erro (apenas quando o status for "failed")
                    type: string
                  exchange:
                    $ref: '#/components/schemas/AgentExchangeSummary'
                  expiresAt:
                    format: date-time
                    type: string
                  message:
                    description: >-
                      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.
                    type: string
                  mode:
                    enum:
                      - extract
                      - chat
                    type: string
                  model:
                    default: spark-2
                    description: >-
                      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.
                    enum:
                      - spark-2
                      - spark-1-pro
                      - spark-1-mini
                    type: string
                  partial:
                    description: >-
                      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:
                    description: >-
                      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`.
                    type: boolean
                  pendingApproval:
                    $ref: '#/components/schemas/AgentPendingApproval'
                  status:
                    enum:
                      - processing
                      - completed
                      - failed
                    type: string
                  stopReason:
                    description: >-
                      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.
                    enum:
                      - credit_limit_reached
                    type: string
                  success:
                    type: boolean
                  suggestions:
                    description: >-
                      Sugestões de acompanhamento que o agente oferece para o
                      próximo turno da conversa.
                    items:
                      properties:
                        label:
                          type: string
                        prompt:
                          type: string
                      type: object
                    type: array
                  threadId:
                    description: A conversa à qual esta execução pertence.
                    format: uuid
                    type: string
                  threadTurn:
                    description: >-
                      O turno desta execução na conversa, com numeração a partir
                      de 1.
                    type: integer
                type: object
          description: Resposta bem-sucedida
        '400':
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Invalid job ID format. Job ID must be a valid UUID.
                    type: string
                type: object
          description: Solicitação inválida — o ID do job não é um UUID válido.
        '404':
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Agent job not found
                    type: string
                type: object
          description: Job do agente não encontrado
      security:
        - bearerAuth: []
components:
  schemas:
    AgentExchangeSummary:
      description: >-
        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.
      properties:
        creditsUsed:
          description: >-
            Créditos consumidos pelas chamadas de providers, ou null quando
            desconhecidos.
          nullable: true
          type: number
        enabled:
          type: boolean
        onTermsRequired:
          enum:
            - skip
            - ask
          type: string
        paidCalls:
          description: Chamadas pagas de providers feitas pela execução.
          type: integer
        requireApproval:
          type: boolean
        requiresAction:
          description: >-
            Apenas para `onTermsRequired: "ask"`, quando uma solicitação de
            aceite de termos encerrou o turno: as chamadas para visualizar e
            aceitar os termos de cada provider. Nenhuma dessas chamadas é
            executada automaticamente, e `terms/accept` só deve ser chamado
            depois que seu usuário concordar explicitamente.
          properties:
            approvalId:
              description: >-
                O `pendingApproval` do tipo `terms` ao qual responder após o
                aceite dos termos.
              type: string
            providers:
              items:
                properties:
                  accept:
                    description: >-
                      A chamada `terms/accept`, no formato `{ provider,
                      capability, options }` para `alexandria` em `/v2/scrape`.
                    type: object
                  adds:
                    type: string
                  capability:
                    type: string
                  digest:
                    description: >-
                      null quando o catálogo não publicou um hash; `terms/show`
                      retorna esse hash.
                    nullable: true
                    type: string
                  name:
                    type: string
                  provider:
                    type: string
                  show:
                    description: >-
                      A chamada `terms/show`, no formato `{ provider,
                      capability, options }` para `alexandria` em `/v2/scrape`.
                    type: object
                  url:
                    type: string
                  version:
                    type: string
                type: object
              type: array
            type:
              enum:
                - accept_terms
              type: string
          type: object
        skippedProviders:
          description: >-
            Providers que teriam ajudado, mas exigem o aceite de termos de uso
            de dados que sua equipe ainda não aceitou. Aplica-se a qualquer modo
            de `onTermsRequired`.
          items:
            properties:
              adds:
                description: O que o provider teria acrescentado.
                type: string
              capability:
                type: string
              name:
                type: string
              provider:
                type: string
              reason:
                enum:
                  - terms_required
                type: string
              termsUrl:
                description: Onde aceitar os termos no painel.
                type: string
              version:
                description: A versão dos termos.
                type: string
            type: object
          type: array
        toolkits:
          description: >-
            Providers fixados. Quando vazio ou ausente, inclui todos os
            providers que a equipe pode usar.
          items:
            type: string
          type: array
      type: object
    AgentPendingApproval:
      description: >-
        A pergunta que interrompeu o turno. Responda no próximo turno da
        conversa com `exchange.approve` ou `exchange.decline`.
      properties:
        calls:
          description: >-
            As chamadas pagas que aguardam aprovação. Vazio em uma aprovação do
            tipo `terms`.
          items:
            properties:
              capability:
                type: string
              creditsEstimate:
                description: Estimativa de créditos, ou null quando desconhecida.
                nullable: true
                type: number
              id:
                description: >-
                  Informe os IDs em `exchange.approve.callIds` para aprovar
                  apenas algumas chamadas.
                type: string
              input:
                description: As opções com as quais a chamada seria executada.
                type: object
              more:
                description: >-
                  Dados de entrada adicionais com os quais a mesma chamada seria
                  executada.
                items:
                  type: object
                type: array
              provider:
                type: string
            type: object
          type: array
        id:
          description: Envie este valor como `approvalId`.
          type: string
        kind:
          description: >-
            `calls`: chamadas pagas de providers suspensas por
            `requireApproval`. `terms`: providers cujos termos de uso de dados
            precisam ser aceitos (`onTermsRequired: "ask"`). Ausente em itens
            registrados antes da implementação das solicitações de aceite de
            termos; esses itens são do tipo `calls`.
          enum:
            - calls
            - terms
          type: string
        reason:
          description: Por que o agente quer fazer essas chamadas.
          type: string
        resolution:
          description: null até que um turno posterior responda à solicitação de aprovação.
          nullable: true
          properties:
            always:
              type: boolean
            approved:
              type: boolean
            byRunId:
              type: string
            callIds:
              items:
                type: string
              type: array
          type: object
        terms:
          description: >-
            Em uma aprovação do tipo `terms`, os providers cujos termos precisam
            ser aceitos.
          items:
            properties:
              adds:
                description: O que o provider acrescentaria.
                type: string
              capability:
                type: string
              digest:
                description: >-
                  null quando o catálogo não publicou um hash; `terms/show`
                  retorna esse hash.
                nullable: true
                type: string
              name:
                type: string
              provider:
                type: string
              url:
                description: Onde aceitar os termos no painel.
                type: string
              version:
                description: A versão dos termos.
                type: string
            type: object
          type: array
      type: object
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.