Retrieve Thread | Confident AI Docs

import requests
url = "https://api.confident-ai.com/v1/threads/threadId"
headers = {"CONFIDENT_API_KEY": "<PROJECT-API-KEY>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "success": true,
  "data": {
    "threadId": "thread-123",
    "createdAt": "2025-01-15T10:30:00Z",
    "lastActivity": "2025-01-15T11:45:00Z",
    "totalTraces": 5,
    "metadata": {
      "userId": "user-456"
    },
    "tags": [
      "support"
    ],
    "metricCollectionName": "conversation-metrics",
    "metricsData": [
      {
        "id": "string",
        "projectId": "string",
        "name": "string",
        "multiTurn": true,
        "createdAt": "2024-01-15T09:30:00Z",
        "threshold": 1.1,
        "strictMode": true,
        "skipped": true,
        "score": 0.95,
        "metricName": "Answer Relevancy"
      }
    ],
    "annotations": [
      {
        "id": "annotation-1",
        "rating": 5,
        "type": "THUMBS_RATING"
      }
    ],
    "traces": [
      {
        "uuid": "trace-uuid-1",
        "startTime": "2025-01-15T10:30:00Z",
        "endTime": "2025-01-15T10:30:05Z",
        "projectId": "string",
        "spans": [
          {
            "id": "string",
            "uuid": "string",
            "name": "string",
            "startTime": "2024-01-15T09:30:00Z",
            "endTime": "2024-01-15T09:30:00Z",
            "traceUuid": "string",
            "status": "SUCCESS",
            "type": "string"
          }
        ],
        "name": "User Message",
        "environment": "production",
        "id": "TRACE-ID"
      }
    ]
  },
  "deprecated": false
}

Retrieves a thread by ID from your Confident AI project.

Path parameters

threadIdstringRequired

This is the thread ID you wish to retrieve.

Headers

CONFIDENT_API_KEYstringRequired

The API key of your Confident AI project.

Response

successboolean

This is true if the thread was successfully retrieved.

dataobject

This maps to the thread retrieved.

deprecatedboolean

This is true if this endpoint is deprecated.