> ## 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.

# Récupérer l’état de l’agent

> Êtes-vous un agent IA qui a besoin d’une clé API Firecrawl ? Consultez [firecrawl.dev/agent-onboarding/SKILL.md](https://www.firecrawl.dev/agent-onboarding/SKILL.md) pour obtenir des instructions d’intégration automatisée.


## OpenAPI

````yaml fr/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 pour interagir avec les services Firecrawl afin d’effectuer des tâches
    de scraping et de crawling web.
  title: Firecrawl API
  version: v2
servers:
  - url: https://api.firecrawl.dev/v2
security:
  - bearerAuth: []
paths:
  /agent/{jobId}:
    parameters:
      - description: L’ID de la tâche de l’agent
        in: path
        name: jobId
        required: true
        schema:
          format: uuid
          type: string
    get:
      tags:
        - Agent
      summary: Récupérer l’état d’une tâche d’agent
      operationId: getAgentStatus
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  creditsUsed:
                    type: number
                  data:
                    description: >-
                      Les données extraites (uniquement présentes lorsque l’état
                      est « completed »). Jamais renseignées pour une exécution
                      ayant échoué, y compris si elle s’est arrêtée après avoir
                      atteint sa limite de crédits.
                    type: object
                  effort:
                    description: >-
                      Budget de raisonnement utilisé pour l’exécution d’agent
                      (présent uniquement pour les exécutions ayant défini le
                      paramètre effort)
                    enum:
                      - low
                      - medium
                      - high
                    type: string
                  error:
                    description: >-
                      Message d’erreur (présent uniquement lorsque le statut est
                      « failed »)
                    type: string
                  exchange:
                    $ref: '#/components/schemas/AgentExchangeSummary'
                  expiresAt:
                    format: date-time
                    type: string
                  message:
                    description: >-
                      Une note de l’agent concernant le résultat. En mode
                      `chat`, une demande de suivi ne sollicitant aucune
                      nouvelle donnée reçoit une réponse ici plutôt que dans
                      `data`. Si l’exécution a échoué après avoir atteint sa
                      limite de crédits, cette note peut préciser ce qui est
                      incomplet.
                    type: string
                  mode:
                    enum:
                      - extract
                      - chat
                    type: string
                  model:
                    default: spark-2
                    description: "Préréglage du modèle utilisé lors de l’exécution de l’agent. Chaque nouvelle exécution utilise spark-2\_; les noms Spark 1 n’apparaissent que dans les exécutions héritées."
                    enum:
                      - spark-2
                      - spark-1-pro
                      - spark-1-mini
                    type: string
                  partial:
                    description: >-
                      JSON récupéré dans la mesure du possible à partir d’une
                      exécution incomplète. Présent uniquement pour certaines
                      exécutions ayant échoué, notamment celles ayant atteint
                      `maxCredits` ; jamais présent pendant le traitement de
                      l’exécution. Des lignes ou des champs peuvent manquer : ne
                      le considérez donc pas comme un résultat complet.
                  partialSchemaValid:
                    description: >-
                      Indique si `partial` est conforme au schéma JSON de la
                      requête. Présent uniquement si `partial` est présent et si
                      la requête incluait un `schema`.
                    type: boolean
                  pendingApproval:
                    $ref: '#/components/schemas/AgentPendingApproval'
                  status:
                    enum:
                      - processing
                      - completed
                      - failed
                    type: string
                  stopReason:
                    description: >-
                      Raison de l’arrêt prématuré d’une exécution ayant échoué.
                      `credit_limit_reached` signifie que l’exécution a atteint
                      sa limite `maxCredits`. Présente uniquement lorsque l’état
                      est « failed ».
                    enum:
                      - credit_limit_reached
                    type: string
                  success:
                    type: boolean
                  suggestions:
                    description: >-
                      Demandes de suivi proposées par l’agent pour le prochain
                      tour du fil.
                    items:
                      properties:
                        label:
                          type: string
                        prompt:
                          type: string
                      type: object
                    type: array
                  threadId:
                    description: Le fil auquel appartient cette exécution.
                    format: uuid
                    type: string
                  threadTurn:
                    description: >-
                      Le numéro du tour de cette exécution dans le fil, à partir
                      de 1.
                    type: integer
                type: object
          description: Réponse réussie
        '400':
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Invalid job ID format. Job ID must be a valid UUID.
                    type: string
                type: object
          description: Requête incorrecte — l’ID de tâche n’est pas un UUID valide.
        '404':
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Agent job not found
                    type: string
                type: object
          description: Tâche d’agent introuvable
      security:
        - bearerAuth: []
components:
  schemas:
    AgentExchangeSummary:
      description: >-
        Ce que l’exécution a fait avec Alexandria. `toolkits` et
        `requireApproval` correspondent aux valeurs retenues pour l’exécution
        après héritage des paramètres du fil.
      properties:
        creditsUsed:
          description: >-
            Nombre de crédits consommés par les appels aux fournisseurs, ou null
            si ce nombre est inconnu.
          nullable: true
          type: number
        enabled:
          type: boolean
        onTermsRequired:
          enum:
            - skip
            - ask
          type: string
        paidCalls:
          description: Appels payants aux fournisseurs effectués au cours de l’exécution.
          type: integer
        requireApproval:
          type: boolean
        requiresAction:
          description: "Uniquement avec `onTermsRequired: \"ask\"`, lorsqu’une demande d’acceptation des conditions a mis fin au tour\_: les appels permettant de consulter et d’accepter les conditions de chaque fournisseur. Aucun de ces appels n’est exécuté automatiquement, et `terms/accept` ne doit être appelé qu’après l’accord explicite de votre utilisateur."
          properties:
            approvalId:
              description: >-
                Le `pendingApproval` de type `terms` auquel répondre une fois
                les conditions acceptées.
              type: string
            providers:
              items:
                properties:
                  accept:
                    description: >-
                      L’appel `terms/accept`, sous la forme `{ provider,
                      capability, options }` pour `/v2/scrape` `alexandria`.
                    type: object
                  adds:
                    type: string
                  capability:
                    type: string
                  digest:
                    description: "null si le catalogue n’a publié aucune empreinte\_; `terms/show` la renvoie."
                    nullable: true
                    type: string
                  name:
                    type: string
                  provider:
                    type: string
                  show:
                    description: >-
                      L’appel `terms/show`, sous la forme `{ provider,
                      capability, options }` pour `/v2/scrape` `alexandria`.
                    type: object
                  url:
                    type: string
                  version:
                    type: string
                type: object
              type: array
            type:
              enum:
                - accept_terms
              type: string
          type: object
        skippedProviders:
          description: >-
            Fournisseurs qui auraient été utiles, mais dont votre équipe n’a pas
            encore accepté les conditions relatives aux données. Quel que soit
            le mode `onTermsRequired`.
          items:
            properties:
              adds:
                description: Ce que le fournisseur aurait apporté.
                type: string
              capability:
                type: string
              name:
                type: string
              provider:
                type: string
              reason:
                enum:
                  - terms_required
                type: string
              termsUrl:
                description: >-
                  L’emplacement dans le tableau de bord où accepter les
                  conditions.
                type: string
              version:
                description: La version des conditions.
                type: string
            type: object
          type: array
        toolkits:
          description: >-
            Fournisseurs épinglés. Une valeur vide ou absente désigne tous les
            fournisseurs que l’équipe peut utiliser.
          items:
            type: string
          type: array
      type: object
    AgentPendingApproval:
      description: >-
        La demande pour laquelle le tour a été interrompu. Répondez-y au
        prochain tour du fil avec `exchange.approve` ou `exchange.decline`.
      properties:
        calls:
          description: >-
            Les appels payants en attente d’approbation. Vide pour une
            approbation de type `terms`.
          items:
            properties:
              capability:
                type: string
              creditsEstimate:
                description: Nombre estimé de crédits, ou null si ce nombre est inconnu.
                nullable: true
                type: number
              id:
                description: >-
                  Transmettez les identifiants dans `exchange.approve.callIds`
                  pour n’approuver que certains appels.
                type: string
              input:
                description: Les options avec lesquelles l’appel serait exécuté.
                type: object
              more:
                description: >-
                  Les paramètres supplémentaires avec lesquels ce même appel
                  serait exécuté.
                items:
                  type: object
                type: array
              provider:
                type: string
            type: object
          type: array
        id:
          description: Transmettez cette valeur dans `approvalId`.
          type: string
        kind:
          description: "`calls`\_: appels payants aux fournisseurs suspendus par `requireApproval`. `terms`\_: fournisseurs dont les conditions relatives aux données doivent être acceptées (`onTermsRequired: \"ask\"`). Absent des éléments créés avant l’introduction des demandes d’acceptation des conditions, qui sont de type `calls`."
          enum:
            - calls
            - terms
          type: string
        reason:
          description: Pourquoi l’agent souhaite effectuer ces appels.
          type: string
        resolution:
          description: >-
            null tant qu’un tour ultérieur n’a pas répondu à la demande
            d’approbation.
          nullable: true
          properties:
            always:
              type: boolean
            approved:
              type: boolean
            byRunId:
              type: string
            callIds:
              items:
                type: string
              type: array
          type: object
        terms:
          description: >-
            Pour une approbation de type `terms`, les fournisseurs dont les
            conditions doivent être acceptées.
          items:
            properties:
              adds:
                description: Ce que le fournisseur apporterait.
                type: string
              capability:
                type: string
              digest:
                description: "null si le catalogue n’a publié aucune empreinte\_; `terms/show` la renvoie."
                nullable: true
                type: string
              name:
                type: string
              provider:
                type: string
              url:
                description: >-
                  L’emplacement dans le tableau de bord où accepter les
                  conditions.
                type: string
              version:
                description: La version des conditions.
                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.