Launch Week 02 wrapped — explore all five launches

List Threads

GEThttps://api.confident-ai.com/v1/threads

Retrieves a list of threads from your Confident AI project.

GET/v1/threads
curl -X GET "https://api.confident-ai.com/v1/threads" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>"
200
{
  "success": true,
  "data": {
    "threads": [
      {
        "threadId": "thread-123",
        "createdAt": "2025-01-15T10:30:00Z",
        "lastActivity": "2025-01-15T11:45:00Z",
        "metadata": {
          "userId": "user-456"
        },
        "tags": [
          "support"
        ],
        "metricCollectionName": "conversation-metrics",
        "totalTraces": 5
      }
    ],
    "totalThreads": 100
  },
  "deprecated": false
}

Headers

  • CONFIDENT_API_KEYstringRequired

    The API key of your Confident AI project.

Query parameters

  • pageinteger

    This specifies the page number of the threads to return. Defaulted to 1.

  • pageSizeinteger

    This specifies the maximum number of threads per page. Defaulted to 25.

  • environmentstring

    This filters the threads by the environment where the thread was created, and returns threads from all environments if not specified.

  • startstring

    This filters for threads created after the specified start datetime. Defaulted to 30 days ago.

  • endstring

    This filters for threads created before the specified end datetime. Defaulted to the current time.

  • sortByenum

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

  • ascendingenum

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

Response

  • successboolean

    This is true if the threads were successfully retrieved.

  • dataobject

    This maps to the list of threads retrieved.

    Show 2 propertiesHide 2 properties
    • threadslist of objects

      This is the list of threads retrieved.

      Show 7 propertiesHide 7 properties
      • threadIdstring

        This is the thread ID you supplied when creating the thread.

      • createdAtstring

        This is when the thread was created.

      • lastActivitystring

        This is when the thread was last active.

      • metadataobject

        This is the custom metadata attached to the thread.

      • tagslist of strings

        This is the list of tags associated with the thread.

      • metricCollectionNamestring

        This is the name of the metric collection assigned to evaluate the thread.

      • totalTracesinteger

        This is the total number of traces in this thread.

    • totalThreadsinteger

      This is the total number of threads retrieved.

  • deprecatedboolean

    This is true if this endpoint is deprecated.

Built byConfident AI