Sign in

v66

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-04176310979.2 KB
session_labels

Create Label

Create a new label

post/api/v1/session_labels/

Request body

session_idinteger required

The internal ID of the session (see Session.session_id)

typestring required

The type of the label (either "auto-rating" or "human-rating")

codestring required

A code describing the quality of the labeled session (either "GOOD", "OK", "BAD", or "N/A")

user_emailstring required

The email of the user who created the label

commentsstring nullable

Comment string describing additional details about the session

issue_categoriesstring[] nullable

Descriptions of issues occurring in the labeled call

Example request

{
  "session_id": 1,
  "type": "auto-rating",
  "code": "GOOD",
  "user_email": "user@email.com",
  "issue_categories": [
    "Silent treatment"
  ]
}

Response

Successful Response

session_idinteger required

The internal ID of the session (see Session.session_id)

typestring required

The type of the label (either "auto-rating" or "human-rating")

codestring required

A code describing the quality of the labeled session (either "GOOD", "OK", "BAD", or "N/A")

user_emailstring required

The email of the user who created the label

commentsstring nullable

Comment string describing additional details about the session

issue_categoriesstring[] nullable

Descriptions of issues occurring in the labeled call

idinteger required

The internal ID of the label

timestampstring required

The timestamp at which the label was created

Example response

{
  "session_id": 1,
  "type": "auto-rating",
  "code": "GOOD",
  "user_email": "user@email.com",
  "issue_categories": [
    "Silent treatment"
  ],
  "id": 1,
  "timestamp": "2024-01-01T12:00:00Z"
}