Skip to main content
 print this page

List SQL AI documents sync jobs

GET 

/nl2sql/sync-jobs

Returns a paginated history of the jobs that sync SQL AI training documents into the chatbot's knowledge base.

Requires SQLAI to be present in the environment's enabled AI services; otherwise the request fails with AI-1004.

Pagination: read next_available in the response. While it is "yes", request the next page by advancing offset by limit. When it is "no" this was the last page and the client must stop. Note that supplying projectionExpression changes the response into a bare array and drops the pagination keys entirely, so do not combine it with paging.

Request

Responses

Page of sync jobs. Check next_available to decide whether to request a further page. When projectionExpression is supplied the body is a bare array instead, with no pagination keys.

Response Headers
    Access-Control-Allow-Origin
    Access-Control-Allow-Methods
    Access-Control-Allow-Headers