> ## Documentation Index
> Fetch the complete documentation index at: https://firecrawl-claude-eager-dijkstra-4orfll.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 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 POST /agent
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:
    post:
      tags:
        - Agent
      summary: >-
        Démarrer une tâche d’agent pour l’extraction de données pilotée par un
        agent
      operationId: startAgent
      requestBody:
        content:
          application/json:
            schema:
              properties:
                auditMetadata:
                  $ref: '#/components/schemas/AuditMetadata'
                effort:
                  description: >-
                    Budget de raisonnement pour la tâche d’agent. Chaque
                    exécution utilise spark-2, donc le paramètre effort peut
                    être envoyé avec ou sans modèle.
                  enum:
                    - low
                    - medium
                    - high
                  type: string
                maxCredits:
                  description: |-
                    <[
                      {
                        "key": "0",
                        "translation": "Nombre maximal de crédits à utiliser pour cette tâche d’agent. La valeur par défaut est de 2500 si elle n’est pas spécifiée. Les valeurs supérieures à 2 500 sont toujours facturées comme des requêtes payantes."
                      }
                    ]</>
                  type: number
                model:
                  default: spark-2
                  description: >-
                    Le modèle à utiliser pour les tâches d’agent. spark-2 est le
                    modèle par défaut et celui sur lequel chaque exécution est
                    effectuée. Les noms de modèles Spark 1 restent acceptés pour
                    assurer la rétrocompatibilité, mais sont obsolètes et
                    redirigent vers spark-2.
                  enum:
                    - spark-2
                    - spark-1-mini
                    - spark-1-pro
                  type: string
                prompt:
                  description: Le prompt décrivant les données à extraire
                  maxLength: 10000
                  type: string
                schema:
                  description: Schéma JSON facultatif pour structurer les données extraites
                  type: object
                strictConstrainToURLs:
                  description: >-
                    Si la valeur est true, l’agent ne visitera que les URL
                    fournies dans le tableau urls
                  type: boolean
                threatProtection:
                  $ref: '#/components/schemas/ThreatProtectionOverride'
                urls:
                  description: Liste facultative d’URL servant à limiter l’agent
                  items:
                    format: uri
                    type: string
                  type: array
                webhook:
                  description: >-
                    Objet de spécification de webhook. S’abonne aux événements
                    du cycle de vie de l’agent (agent.started, agent.action,
                    agent.completed, agent.failed, agent.cancelled).
                  properties:
                    events:
                      default:
                        - started
                        - action
                        - completed
                        - failed
                        - cancelled
                      description: >-
                        Les événements à envoyer à l’URL du webhook. Par défaut,
                        tous les événements sont envoyés.
                      items:
                        enum:
                          - started
                          - action
                          - completed
                          - failed
                          - cancelled
                        type: string
                      type: array
                    headers:
                      additionalProperties:
                        type: string
                      description: En-têtes à envoyer à l’URL du webhook.
                      type: object
                    metadata:
                      additionalProperties:
                        type: string
                      description: >-
                        Métadonnées personnalisées incluses dans toutes les
                        charges utiles de webhook de cette tâche d’agent.
                      type: object
                    url:
                      description: L’URL à laquelle envoyer les événements webhook.
                      format: uri
                      type: string
                  required:
                    - url
                  type: object
              required:
                - prompt
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  id:
                    format: uuid
                    type: string
                  success:
                    type: boolean
                type: object
          description: La tâche de l’agent a démarré avec succès
        '400':
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: 'Invalid JSON schema: ...'
                    type: string
                type: object
          description: >-
            Requête incorrecte — le corps de la requête n’a pas passé la
            validation (par exemple, un schéma JSON non valide).
        '402':
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Payment required to access this resource.
                    type: string
                type: object
          description: Paiement requis
        '403':
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: >-
                      This URL (https://example.com) is blocked by your
                      organization's threat protection policy (rule: blocklist).
                      If you believe this is a mistake, contact your
                      organization administrator to adjust the policy (e.g.
                      whitelist the domain).
                    type: string
                type: object
          description: >-
            Interdit — une URL fournie est bloquée par la politique de
            protection contre les menaces de l’équipe.
        '429':
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Rate limit exceeded.
                    type: string
                type: object
          description: Trop de requêtes
        '500':
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Failed to passthrough agent request.
                    type: string
                type: object
          description: >-
            Erreur interne du serveur — le service d’agent n’a pas pu être
            joint.
      security:
        - bearerAuth: []
components:
  schemas:
    AuditMetadata:
      additionalProperties: false
      description: >-
        Informations d’attribution de l’utilisateur incluses dans les événements
        de journalisation SIEM lorsque SIEM Logging est activé pour
        l’organisation.
      properties:
        username:
          description: Le nom d’utilisateur associé à la requête.
          maxLength: 1024
          type: string
      required:
        - username
      type: object
    ThreatProtectionOverride:
      description: >-
        Dérogation [Protection contre les
        menaces](https://docs.firecrawl.dev/features/threat-protection) au
        niveau de la requête. Les champs que vous fournissez remplacent les
        champs correspondants de la politique de votre organisation pour cette
        requête uniquement ; les champs omis conservent leurs valeurs définies
        au niveau de l'organisation. La Protection contre les menaces doit être
        activée pour votre équipe (fonctionnalité Enterprise) ; sinon, la
        requête est rejetée avec un code 403. Si votre organisation a désactivé
        les dérogations par requête, toute requête qui inclut cet objet est
        rejetée avec un code 403. Si la Protection contre les menaces est
        appliquée à votre équipe, `mode` ne peut pas être défini sur `off`.
      properties:
        blacklist:
          description: >-
            Domaines à toujours bloquer, sous forme de domaines simples
            (`example.com`) ou de motifs avec joker (`*.example.com`). Sans
            protocole, chemin ni port.
          items:
            type: string
          maxItems: 1000
          type: array
        blockedTlds:
          description: >-
            Domaines de premier niveau à bloquer systématiquement, en minuscules
            et sans le point initial (par ex. `zip`).
          items:
            type: string
          maxItems: 1000
          type: array
        failurePolicy:
          description: >-
            Comportement à adopter lorsque le classifieur est injoignable :
            `closed` bloque la requête, `open` l'autorise.
          enum:
            - open
            - closed
          type: string
        mode:
          description: >-
            Mode d’analyse des URL pour cette requête. `normal` vérifie les URL
            via Google Web Risk (+2 crédits par URL analysée).
          enum:
            - 'off'
            - normal
          type: string
        riskScoreThreshold:
          description: >-
            Score de risque normalisé (0–100) à partir duquel une décision du
            classifieur bloque l’URL. Plus il est faible, plus le filtrage est
            strict.
          example: 75
          maximum: 100
          minimum: 0
          type: integer
        whitelist:
          description: >-
            Domaines à toujours autoriser, sous forme de domaines simples ou de
            motifs avec joker. Prend le pas sur toutes les autres règles.
          items:
            type: string
          maxItems: 1000
          type: array
      title: Threat Protection Override
      type: object
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http

````