Skip to main content

Asynchronous mode

An API call that includes the mode=async key-value pair will be satisfied asynchronously:
In response, the API will provide a JSON job identifier:
The job results, completion, or content or job status can be requested any time thereafter by passing back the ID:
The results, completion, or content, if ready, will be returned in the same format as synchronous results, a synchronous completion, or synchronous content; otherwise, a JSON status message will be returned. A retrieving status indicates that the search, conversation, or request is in progress:
A failed status indicates that the search, conversation, or request was unsuccessful and the call should be retried:
These are the scheduling request parameters: These are the response parameters: