Skip to content
vocapable.Docs

Create a scorecard (CC5-R1)

POST
/v1/workspace/quality/scorecards
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/quality/scorecards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example", "assignment": { "directions": [ "inbound" ], "handler_kinds": [ "human" ], "queue_keys": [ "example" ], "team_ids": [ "example" ], "channel": "voice" }, "definition": { "sections": [ { "key": "example", "title": "example", "weight": 1, "questions": [ { "key": "example", "text": "example", "type": "yes_no", "weight": 1, "allow_na": false, "auto_fail": false, "guidance": "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
QualityScorecardCreate
object
name
required
Name
string
>= 1 characters <= 120 characters
description
Any of:
string
<= 1000 characters
assignment
QualityAssignment

Which calls and text conversations a scorecard applies to; an empty list means any, and the dimensions are AND-ed. handler_kinds includes ai to grade the AI agents’ calls with the same card (PRD D2). When several cards match one piece of work, a card naming its queue comes first, then one naming its handler’s team, then the rest (docs/contact-center/quality.md § Assignment).

object
directions
Directions
Array<string>
Allowed values: inbound outbound
handler_kinds
Handler Kinds
Array<string>
>= 1 items
Allowed values: human ai
queue_keys
Queue Keys
Array<string>
<= 200 items
team_ids
Team Ids
Array<string>
<= 50 items
channel
Channel
string
default: voice
Allowed values: voice sms any
definition
required
QualityDefinitionIn
object
sections
required
Sections
Array<object>
>= 1 items <= 20 items
QualitySectionIn
object
key
required
Key
string
>= 1 characters <= 40 characters
title
required
Title
string
>= 1 characters <= 120 characters
weight
required
Weight
integer
>= 1 <= 100
questions
required
Questions
Array<object>
>= 1 items <= 100 items
QualityQuestionIn
object
key
required
Key
string
>= 1 characters <= 40 characters
text
required
Text
string
>= 1 characters <= 300 characters
type
required
Type
string
Allowed values: yes_no scale
weight
required
Weight
integer
>= 1 <= 100
allow_na
Allow Na
boolean
auto_fail
Auto Fail
boolean
guidance
Any of:
string
<= 1000 characters

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
QualityScorecard
object
id
required
Id
string
name
required
Name
string
description
required
Any of:
string
status
required
Status
string
Allowed values: active archived
assignment
required
QualityAssignment

Which calls and text conversations a scorecard applies to; an empty list means any, and the dimensions are AND-ed. handler_kinds includes ai to grade the AI agents’ calls with the same card (PRD D2). When several cards match one piece of work, a card naming its queue comes first, then one naming its handler’s team, then the rest (docs/contact-center/quality.md § Assignment).

object
directions
Directions
Array<string>
Allowed values: inbound outbound
handler_kinds
Handler Kinds
Array<string>
>= 1 items
Allowed values: human ai
queue_keys
Queue Keys
Array<string>
<= 200 items
team_ids
Team Ids
Array<string>
<= 50 items
channel
Channel
string
default: voice
Allowed values: voice sms any
current_version
required
QualityScorecardVersion
object
id
required
Id
string
version
required
Version
integer
question_count
required
Question Count
integer
locked
required
Locked
boolean
sections
required
Sections
Array<object>
QualitySection
object
key
required
Key
string
title
required
Title
string
weight
required
Weight
integer
questions
required
Questions
Array<object>
QualityQuestion
object
key
required
Key
string
text
required
Text
string
type
required
Type
string
Allowed values: yes_no scale
weight
required
Weight
integer
allow_na
required
Allow Na
boolean
auto_fail
required
Auto Fail
boolean
guidance
required
Any of:
string
fingerprint
required
Fingerprint
string
points
required
Points
number
created_at
required
Created At
string format: date-time
versions
required
Versions
Array<object>
QualityScorecardVersionSummary
object
id
required
Id
string
version
required
Version
integer
question_count
required
Question Count
integer
locked
required
Locked
boolean
created_at
required
Created At
string format: date-time
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
Example
{
  "status": "active",
  "assignment": {
    "directions": [
      "inbound"
    ],
    "handler_kinds": [
      "human"
    ],
    "channel": "voice"
  },
  "current_version": {
    "sections": [
      {
        "questions": [
          {
            "type": "yes_no"
          }
        ]
      }
    ]
  }
}

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": {}
    }
  ]
}