Threads

List Threads

Retrieves a list of threads from your Confident AI project.

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Query parameters

pageintegerOptional>=1
This specifies the page number of the threads to return. Defaulted to 1.
pageSizeintegerOptional>=1
This specifies the maximum number of threads per page. Defaulted to 25.
environmentstringOptional
This filters the threads by the environment where the thread was created, and returns threads from all environments if not specified.
startstringOptionalformat: "date-time"
This filters for threads created after the specified start datetime. Defaulted to 30 days ago.
endstringOptionalformat: "date-time"
This filters for threads created before the specified end datetime. Defaulted to the current time.
sortByenumOptional

This determines the field to sort by. Defaulted to lastActivity.

Allowed values:
ascendingenumOptional

This determines if the field specified in sortBy should be in ascending order. Defaults to false.

Allowed values:

Response

successboolean
This is true if the threads were successfully retrieved.
dataobject
This maps to the list of threads retrieved.
deprecatedboolean
This is true if this endpoint is deprecated.