API Reference
API Reference

Get Label By Id

GET/api/v1/session_labels/{session_label_id}

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

Path parameters

session_label_id integer path required

Responses

200Successful Response

application/json

response SessionLabel required
8 fields
session_idintegerrequired

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

typestringrequired

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

codestringrequired

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

user_emailstringrequired

The email of the user who created the label

commentsstring | nulloptional

Comment string describing additional details about the session

issue_categoriesstring[] | nulloptional

Descriptions of issues occurring in the labeled call

Default []
Item schema
itemsstringrequired
idintegerrequired

The internal ID of the label

timestampstringrequired

The timestamp at which the label was created

Response example
{
  "session_id": 0,
  "type": "string",
  "code": "string",
  "user_email": "string",
  "comments": "string",
  "issue_categories": [],
  "id": 0,
  "timestamp": "string"
}
422Validation Error

application/json

response HTTPValidationError required
1 field
detailValidationError[]optional
Item schema
itemsValidationErrorrequired
3 fields
locstring | integer[]required
Item schema
itemsstring | integerrequired
2 options
Option 1stringrequired
Option 2integerrequired
msgstringrequired
typestringrequired
Response example
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}