Sign in
Conversational AI

List Ongoing And Recent Crawl Jobs Created By A User

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

get/v1/convai/knowledge-base/crawl

Query parameters

include_job_idsstring[] nullable

Ids of additional crawl jobs to retrieve

Ids of additional crawl jobs to retrieve

page_sizeinteger

How many documents to return at maximum. Can not exceed 100, defaults to 30.

How many documents to return at maximum. Can not exceed 100, defaults to 30.

cursorstring nullable

Used for fetching next page. Cursor is returned in the response.

Used for fetching next page. Cursor is returned in the response.

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

next_cursorstring nullable

Changes

Changed in 1 of the 26 revisions of this API.1