{
  "url": "https://telipot.com/catalog/capabilities/web.crawl.status",
  "id": "web.crawl.status",
  "description": "Progress and pages of a website crawl",
  "platform": "web",
  "providers": [
    {
      "slug": "firecrawl",
      "name": "Firecrawl"
    }
  ],
  "tasks": 1,
  "taskPages": [
    {
      "id": "firecrawl.web.crawl.status",
      "name": "Crawl progress, credits used and pages by job id",
      "provider": {
        "slug": "firecrawl",
        "name": "Firecrawl"
      },
      "capability": "web.crawl.status",
      "platform": "web",
      "kind": "data",
      "tier": "core",
      "identity": "key",
      "identityLabel": "Your plan",
      "price": {
        "amount": "Free",
        "state": "free",
        "label": "Free",
        "detail": "Free from the tool",
        "type": "free"
      },
      "providers": 1,
      "retention": "standard",
      "runsOn": "free",
      "live": true,
      "summary": "Get the status of a crawl job",
      "method": "GET",
      "path": "/crawl/{id}",
      "host": "https://api.firecrawl.dev/v2",
      "docsUrl": "https://docs.firecrawl.dev/api-reference/endpoint/crawl-get",
      "auth": {
        "scheme": "bearer",
        "label": "bearer · Authorization: Bearer",
        "short": "bearer · Authorization"
      },
      "scope": "any_account",
      "principal": "organization",
      "requiredScopes": [],
      "verification": {
        "state": "untestable",
        "label": "Untestable",
        "detail": "needs the id of a job that costs credits to start"
      },
      "input": [
        {
          "name": "id",
          "location": "pathParams",
          "type": "string",
          "required": true,
          "constraints": [],
          "note": "The ID of the crawl job (a UUID)"
        },
        {
          "name": "skip",
          "location": "queryParams",
          "type": "integer",
          "required": false,
          "constraints": [
            "at least 0"
          ],
          "note": "Offset into the pages, as in the next URL of a truncated response; the docs describe it, the OpenAPI document does not list it"
        }
      ],
      "sampleInput": {
        "id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "inputSchema": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The ID of the crawl job (a UUID)",
            "examples": [
              "123e4567-e89b-12d3-a456-426614174000"
            ]
          },
          "skip": {
            "type": "integer",
            "description": "Offset into the pages, as in the next URL of a truncated response; the docs describe it, the OpenAPI document does not list it",
            "minimum": 0
          }
        },
        "required": [
          "id"
        ],
        "additionalProperties": false
      },
      "output": [
        {
          "name": "status",
          "type": "string"
        },
        {
          "name": "total",
          "type": "integer",
          "description": "Pages completed or still in flight, failed pages excluded"
        },
        {
          "name": "completed",
          "type": "integer",
          "description": "Pages crawled so far"
        },
        {
          "name": "creditsUsed",
          "type": "integer",
          "description": "Credits the crawl has used so far"
        },
        {
          "name": "expiresAt",
          "type": "string"
        },
        {
          "name": "createdAt",
          "type": "string"
        },
        {
          "name": "completedAt",
          "type": "string",
          "description": "Present only once the crawl has ended"
        },
        {
          "name": "duration",
          "type": "number",
          "description": "Seconds"
        },
        {
          "name": "next",
          "type": "string | null",
          "description": "URL of the next 10MB of pages; absent or null at the end, but also set while the crawl runs"
        },
        {
          "name": "data",
          "type": "object[]"
        }
      ],
      "outputSchema": {
        "type": "object",
        "required": [
          "status",
          "total",
          "completed",
          "creditsUsed"
        ],
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "scraping",
              "completed",
              "failed",
              "cancelled"
            ]
          },
          "total": {
            "type": "integer",
            "description": "Pages completed or still in flight, failed pages excluded"
          },
          "completed": {
            "type": "integer",
            "description": "Pages crawled so far"
          },
          "creditsUsed": {
            "type": "integer",
            "description": "Credits the crawl has used so far"
          },
          "expiresAt": {
            "type": "string"
          },
          "createdAt": {
            "type": "string"
          },
          "completedAt": {
            "type": "string",
            "description": "Present only once the crawl has ended"
          },
          "duration": {
            "type": "number",
            "description": "Seconds"
          },
          "next": {
            "type": [
              "string",
              "null"
            ],
            "description": "URL of the next 10MB of pages; absent or null at the end, but also set while the crawl runs"
          },
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "markdown": {
                  "type": "string"
                },
                "metadata": {
                  "type": "object",
                  "properties": {
                    "title": {
                      "anyOf": [
                        {
                          "type": "string"
                        },
                        {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        }
                      ]
                    },
                    "description": {
                      "anyOf": [
                        {
                          "type": "string"
                        },
                        {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        }
                      ]
                    },
                    "sourceURL": {
                      "type": "string"
                    },
                    "url": {
                      "type": "string"
                    },
                    "statusCode": {
                      "type": "integer"
                    },
                    "error": {
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  }
                }
              }
            }
          }
        }
      },
      "commands": {
        "mode": "run",
        "cli": "telipot run firecrawl.web.crawl.status \\\n  --input-json '{\"id\":\"123e4567-e89b-12d3-a456-426614174000\"}'",
        "http": "curl https://api.telipot.com/v1/tasks/firecrawl.web.crawl.status/run \\\n  -H \"Authorization: Bearer $TELIPOT_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"id\":\"123e4567-e89b-12d3-a456-426614174000\"}'",
        "quote": "telipot run firecrawl.web.crawl.status \\\n  --input-json '{\"id\":\"123e4567-e89b-12d3-a456-426614174000\"}' \\\n  --quote"
      },
      "siblings": []
    }
  ]
}