Passer au contenu principal
GET
/
crawl
/
{id}
Récupérer l’état d’une tâche de crawl
curl --request GET \
  --url https://api.firecrawl.dev/v1/crawl/{id} \
  --header 'Authorization: Bearer <token>'
{
  "status": "<string>",
  "total": 123,
  "completed": 123,
  "creditsUsed": 123,
  "expiresAt": "2023-11-07T05:31:56Z",
  "next": "<string>",
  "data": [
    {
      "markdown": "<string>",
      "html": "<string>",
      "rawHtml": "<string>",
      "links": [
        "<string>"
      ],
      "screenshot": "<string>",
      "metadata": {
        "title": "<string>",
        "description": "<string>",
        "language": "<string>",
        "sourceURL": "<string>",
        "keywords": "<string>",
        "ogLocaleAlternate": [
          "<string>"
        ],
        "<any other metadata> ": "<string>",
        "statusCode": 123,
        "error": "<string>"
      }
    }
  ]
}
Remarque : une nouvelle version v2 de cette API est désormais disponible avec des fonctionnalités et des performances améliorées.

Autorisations

Authorization
string
header
requis

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

Paramètres de chemin

id
string<uuid>
requis

L’identifiant de la tâche de crawl

Réponse

Réponse en cas de succès

status
string

L’état actuel du crawl. Peut avoir pour valeur scraping, completed ou failed.

total
integer

Nombre total de pages ayant fait l'objet d'une tentative de crawl.

completed
integer

Le nombre de pages explorées avec succès.

creditsUsed
integer

Le nombre de crédits utilisés pour l’opération de crawl.

expiresAt
string<date-time>

La date et l’heure d’expiration du crawl.

next
string | null

L’URL permettant de récupérer les 10 Mo de données suivants. Retournée si l’exploration n’est pas terminée ou si la réponse dépasse 10 Mo.

data
object[]

Les données du crawl.