Evaluation

Explains APIs available to evaluate your conversations.

Start evaluation

post

Start asynchronous evaluation of a conversation.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

representativeIdstringRequired

conversationany ofRequired

or

or

Responses

200

The request has succeeded.

application/json

idstringRequired

teamIdstringRequired

conversationIdstringOptional

payloadanyRequired

statusstring · enumRequiredPossible values:

errorstringOptional

post

/api/v1/evaluate

HTTPcURLJavaScriptPython

POST /api/v1/evaluate HTTP/1.1
Host: api.usescore.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 152

{
  "representativeId": "text",
  "conversation": {
    "type": "CALL",
    "url": "text",
    "date": "text",
    "descriptor": "text",
    "customFields": [
      {
        "key": "text",
        "value": "text"
      }
    ]
  }
}

200

The request has succeeded.

{
  "id": "text",
  "teamId": "text",
  "conversationId": "text",
  "payload": null,
  "status": "PROCESSING",
  "error": "text"
}

Get progress

get

Get the progress of an asynchronous evaluation. This can be useful to poll whether a triggered evaluation is completed or not.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

progressIdstringRequired

Responses

200

The request has succeeded.

application/json

get

/api/v1/evaluate/progress/{progressId}

HTTPcURLJavaScriptPython

GET /api/v1/evaluate/progress/{progressId} HTTP/1.1
Host: api.usescore.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

The request has succeeded.

{
  "data": {
    "id": "text",
    "teamId": "text",
    "conversationId": "text",
    "payload": null,
    "status": "PROCESSING",
    "error": "text"
  }
}