For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Trust CenterStatusSupportGet a demoPlatform
DocumentationEvals API ReferenceIntegrations & OTELPlatform SettingsSelf-HostingGuidesChangelog
DocumentationEvals API ReferenceIntegrations & OTELPlatform SettingsSelf-HostingGuidesChangelog
  • Get Started
    • Introduction
    • Quickstart
    • Authentication
    • Data Models
    • API Conventions
  • Data Models
  • Evals
      • POSTRun LLM Evals
      • POSTEvaluate Span
      • POSTEvaluate Trace
      • POSTEvaluate Thread
  • Legacy
LogoLogo
Trust CenterStatusSupportGet a demoPlatform
EvalsEvaluate

Evaluate Thread

POST
https://api.confident-ai.com/v1/evaluate/threads/:threadId
POST
/v1/evaluate/threads/:threadId
$curl -X POST https://api.confident-ai.com/v1/evaluate/threads/threadId \
>     -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "metricCollection": "Collection Name",
>  "chatbotRole": "You are a rich, powerful..."
>}'
200Successful
1{
2  "success": true,
3  "data": {
4    "id": "THREAD-ID"
5  },
6  "deprecated": false
7}
Triggers evaluation of a thread using a specified metric collection and optional chatbot role instructions.
Was this page helpful?
Previous

Simulate Conversation

Next
Built with

Path parameters

threadIdstringRequired
The thread ID of the thread you wish to evaluate.

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Request

metricCollectionstringRequired

This is the name of the multi-turn metric collection to evaluate the thread.

chatbotRolestringOptional
The role or purpose of the chatbot in the thread.

Response

successboolean
This is true if the thread was successfully evaluated.
dataobject
deprecatedboolean
This is true if this endpoint is deprecated.