Conversational AI

Get Crawl Job Details

Changed on

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

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

Path parameters

crawl_job_idstring required

The id of the crawl job to retrieve

Headers

xi-api-keystring 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

Successful Response

type'discovery' | 'sitemap'
seed_urlstring required
patternstring nullable
exclude_patternsstring[]

URLs matching any of these patterns are skipped, even if they match pattern.

max_pagesinteger required
auto_discoverboolean

Whether to automatically discover and enqueue additional pages found while crawling.

status'queued' | 'processing' | 'succeeded' | 'failed' | 'skipped' | 'cancelled'
pages_identifiedinteger
pages_scrapedinteger
pages_skippedinteger
pages_failedinteger
root_folder_idstring required
updated_atinteger required
idstring required
created_atinteger required

Changes