> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gurubase.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Crawl Status

> Get the current status of a website crawl operation

Retrieves the current status and details of a specific crawl operation. This endpoint allows you to monitor the progress of an ongoing crawl or check the results of a completed crawl.

When the crawl is completed, the discovered URLs are not indexed immediately. You need to manually add the discovered URLs as a data source by passing them to [Create Data Source](/api-reference/endpoints/create-datasources) endpoint.

## Path Parameters

<ParamField path="guru_slug" type="string" required>
  The slug of the Guru type associated with the crawl
</ParamField>

<ParamField path="crawl_id" type="string" required>
  The unique identifier of the crawl operation to check
</ParamField>

## Headers

<ParamField header="x-api-key" type="string" required>
  Your API key for authentication. You can obtain your API key from the [Gurubase dashboard](https://app.gurubase.io/api-keys).
</ParamField>

### Response

<ResponseField name="id" type="string">
  Unique identifier for the crawl operation
</ResponseField>

<ResponseField name="url" type="string">
  The root URL that was crawled
</ResponseField>

<ResponseField name="status" type="string" enum={["RUNNING", "COMPLETED", "FAILED", "STOPPED"]}>
  Current status of the crawl operation
</ResponseField>

<ResponseField name="guru_type" type="string">
  The Guru type that the crawl was initiated for
</ResponseField>

<ResponseField name="discovered_urls" type="list">
  List of URLs discovered during crawling
</ResponseField>

<ResponseField name="start_time" type="string">
  Timestamp when crawl started (ISO 8601 format)
</ResponseField>

<ResponseField name="end_time" type="string">
  Timestamp when crawl ended (ISO 8601 format)
</ResponseField>

<ResponseField name="error_message" type="string">
  Error message if the crawl failed (only present if there was an error)
</ResponseField>

<ResponseField name="ignore_query_params" type="boolean">
  Whether query parameters are being stripped from discovered URLs
</ResponseField>

<ResponseExample>
  ```json 200 theme={null}
  {
      "id": 211,
      "url": "https://getanteon.com/",
      "status": "COMPLETED",
      "guru_type": "anteon",
      "discovered_urls": ["https://getanteon.com/features/", "https://getanteon.com/pricing/"],
      "start_time": "2025-02-21T10:25:22.710211Z",
      "end_time": "2025-02-21T10:35:45.521433Z",
      "link_limit": 1500,
      "ignore_query_params": true
  }
  ```

  ```json 404 theme={null}
  {
      "msg": "Crawl not found"
  }
  ```

  ```json 400 theme={null}
  {
      "msg": "Invalid request"
  }
  ```
</ResponseExample>