Sign in

v5

latestOpenAPI 3.1.02026-08-043621,4011.8 MB
Conversational AI

Get Crawl Job Details

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

get/v1/convai/knowledge-base/crawl/{crawl_job_id}

Path parameters

crawl_job_idstring required

The id of the crawl job to retrieve

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.

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
max_depthinteger required
max_pagesinteger required
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