v5
OpenAPI 3.1.02026-08-043621,4011.8 MBConversational AI
Cancel Crawl Job
Cancel a crawl job and delete all associated documents and folders.
post/v1/convai/knowledge-base/crawl/{crawl_job_id}/cancel
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
{"stackTrail":"paths:/v1/convai/knowledge-base/crawl/{crawl_job_id}/cancel:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}