Skip to content
vocapable.Docs

Check a skill requirement written as text (CC1-R2)

POST
/v1/workspace/contact-center/requirements/parse
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/contact-center/requirements/parse \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expression": "example" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
CcRequirementParseRequest

A requirement in text, e.g. (Spanish>=3 OR Portuguese>=3) AND Billing>=2 AND NOT tier:trainee.

object
expression
required
Expression
string
>= 1 characters <= 1000 characters
Examplegenerated
{
  "expression": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
CcRequirementParse

The engine’s shape for a step (requirements + any_of), the canonical text (it parses back to the same requirement) and the plain-language reading.

object
requirements
required
Requirements
Array<object>
CcRequirement

skill >= min_proficiency; negate: the agent must NOT hold it at that level.

object
skill_id
required
Skill Id
string
>= 1 characters <= 64 characters /^[A-Za-z0-9_-]+$/
min_proficiency
required
Min Proficiency
integer
>= 1 <= 5
negate
Negate
boolean
any_of
required
Any Of
Array<object>
CcRequirementGroup

An OR group (CC1-R2): at least one alternative holds; each alternative is the AND of its terms. (Spanish>=3 OR Portuguese>=3) is two one-term alternatives.

object
alternatives
required
Alternatives
Array<Array<object>>
>= 2 items <= 10 items
term_count
required
Term Count
integer
expression
required
Expression
string
summary
required
Summary
string
Example
{
  "requirements": [
    {
      "negate": false
    }
  ],
  "any_of": [
    {
      "alternatives": [
        [
          {
            "negate": false
          }
        ]
      ]
    }
  ]
}

422

Section titled “422”

Cc_requirement_invalid: reason, position, term