---
title: "Get Crawl Job Details"
method: GET
path: "/v1/convai/knowledge-base/crawl/{crawl_job_id}"
tags: ["Conversational AI"]
---

# Get Crawl Job Details

`GET /v1/convai/knowledge-base/crawl/{crawl_job_id}`

## Request

- Base URL: `https://api.elevenlabs.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.elevenlabs.io/v1/convai/knowledge-base/crawl/{crawl_job_id}`
- Auth: none declared

Get details about a specific crawl job including status and progress.

## Path parameters

- `crawl_job_id` string, required: The id of the crawl job to retrieve

## Headers

- `xi-api-key` string, nullable: Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

## Response `200`

Successful Response

- GetCrawlJobResponseModel
  - `type` 'discovery' | 'sitemap'
  - `seed_url` string, required
  - `pattern` string, nullable
  - `exclude_patterns` string[]: URLs matching any of these patterns are skipped, even if they match `pattern`.
  - `max_pages` integer, required
  - `auto_discover` boolean: Whether to automatically discover and enqueue additional pages found while crawling.
  - `status` 'queued' | 'processing' | 'succeeded' | 'failed' | 'skipped' | 'cancelled'
  - `pages_identified` integer
  - `pages_scraped` integer
  - `pages_skipped` integer
  - `pages_failed` integer
  - `root_folder_id` string, required
  - `updated_at` integer, required
  - `id` string, required
  - `created_at` integer, required

## Other responses

- `422`: Validation Error

## Changes

- **2026-10-20** `70227534bb54`: 1 info
  - added the optional property `exclude_patterns` to the response with the `200` status
- **2026-09-30** `0b2f5145d7e6`: 1 warning
  - removed the optional property `max_depth` from the response with the `200` status
- **2026-09-23** `cefd6ab6f610`: 1 info
  - added the optional property `auto_discover` to the response with the `200` status
- **2026-09-19** `e1bb68b2a601`: 1 breaking, 2 info
  - the response property `max_depth` became optional for the status `200`
  - the `max_depth` response's property default value `3` was added for the status `200`
  - response property `max_depth` deprecated
- **2026-07-26** `494d96419d15`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/elevenlabs/apis/elevenlabs-api-documentation/changes/v1/convai/knowledge-base/crawl/:crawl_job_id/get.md)

---

[API](https://skmtc.dev/elevenlabs/apis/elevenlabs-api-documentation.md) - [All operations](https://skmtc.dev/elevenlabs/apis/elevenlabs-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/elevenlabs/apis/elevenlabs-api-documentation/revisions/d04f5e77c40a?raw)