---
title: "List Ongoing And Recent Crawl Jobs Created By A User"
method: GET
path: "/v1/convai/knowledge-base/crawl"
tags: ["Conversational AI"]
---

# List Ongoing And Recent Crawl Jobs Created By A User

`GET /v1/convai/knowledge-base/crawl`

Get a list of ongoing and recent crawl jobs for the user.

## Query parameters

- `include_job_ids` string[], nullable — Ids of additional crawl jobs to retrieve
- `page_size` integer — How many documents to return at maximum. Can not exceed 100, defaults to 30.
- `cursor` string, nullable — Used for fetching next page. Cursor is returned in the response.

## 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

- ListCrawlJobsResponseModel
  - `crawl_jobs` GetCrawlJobResponseModel[], required
    - `type` 'discovery' | 'sitemap'
    - `seed_url` string, required
    - `pattern` string, nullable
    - `max_depth` integer — Deprecated - this field is a no-op and will be removed in a future version.
    - `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
  - `next_cursor` string, nullable

## Other responses

- `422` — Validation Error

## Changes

- **2026-09-23** `cefd6ab6f610` — 1 info
  - added the optional property `crawl_jobs/items/auto_discover` to the response with the `200` status
- **2026-09-19** `e1bb68b2a601` — 1 breaking, 2 info
  - the response property `crawl_jobs/items/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 `crawl_jobs/items/max_depth` deprecated
- **2026-07-26** `494d96419d15` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/elevenlabs/apis/elevenlabs-api-documentation/changes/v1/convai/knowledge-base/crawl/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/48a38e3b0dbd?raw)