Skip to content
vocapable.Docs

Start a blind calibration session (CC5-R4)

POST
/v1/workspace/quality/calibration-sessions
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/quality/calibration-sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "scorecard_id": "example", "include_ai": true, "calls": [ { "workspace_call_id": "example", "ai_call_id": "example", "conversation_id": "example" } ], "reviewer_user_ids": [ "example" ] }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
Any of:
string

Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries Idempotent-Replay: true. A UUID is the documented shape.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
QualityCalibrationCreate
object
name
required
Name
string
>= 1 characters <= 120 characters
scorecard_id
required
Scorecard Id
string
<= 64 characters
include_ai
Include Ai
boolean
default: true
calls
required
Calls
Array<object>
>= 1 items <= 100 items
QualityCallRefIn

What is evaluated: a person’s call (workspace_call_id), an AI agent’s call (ai_call_id) or a routed text conversation (conversation_id, CC8-R1).

object
workspace_call_id
Any of:
string
<= 64 characters
ai_call_id
Any of:
string
<= 64 characters
conversation_id
Any of:
string
<= 64 characters
reviewer_user_ids
required
Reviewer User Ids
Array<string>
>= 1 items <= 20 items

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
QualityCalibrationSession
object
id
required
Id
string
name
required
Name
string
scorecard_id
required
Scorecard Id
string
scorecard_name
required
Scorecard Name
string
scorecard_version
required
Scorecard Version
integer
status
required
Status
string
Allowed values: open closed
include_ai
required
Include Ai
boolean
reviewers
required
Reviewers
Array<object>
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
calls
required
Calls
Array<object>
QualityCalibrationCall
object
workspace_call_id
required
Any of:
string
ai_call_id
required
Any of:
string
my_evaluation_id
required
Any of:
string
my_status
required
Any of:
string
Allowed values: draft submitted acknowledged completed needs_review reviewed
submitted
required
Submitted
integer
expected
required
Expected
integer
results
required
Any of:
QualityCalibrationResults
object
questions
required
Questions
Array<object>
QualityCalibrationQuestion
object
question_key
required
Question Key
string
text
required
Text
string
calls
required
Calls
integer
inter_rater_agreement
required
Any of:
number
ai_calibrated_calls
required
Ai Calibrated Calls
integer
ai_agreement
required
Any of:
number
ai_kappa
required
Any of:
number
calls
required
Calls
Array<object>
QualityCalibrationCallScores
object
workspace_call_id
required
Any of:
string
ai_call_id
required
Any of:
string
human_scores
required
Human Scores
Array<number>
mean
required
Any of:
number
stdev
required
Any of:
number
spread
required
Any of:
number
ai_score
required
Any of:
number
can_close
required
Can Close
boolean
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
closed_at
required
Any of:
string format: date-time
Example
{
  "status": "open",
  "calls": [
    {
      "my_status": "draft"
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}