Skip to content
vocapable.Docs

Read current skill configuration and effect evidence requirements

GET
/v1/agents/{agent_id}/skills
curl --request GET \
  --url https://api.vocapable.com/v1/agents/example/skills \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
agent_id
required
Agent Id
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
AgentSkills
object
agent_id
required
Agent Id
string
published_agent_version_id
required
Any of:
string
checked_at
required
Checked At
string format: date-time
skills
required
Skills
Array<object>
>= 6 items <= 6 items
AgentSkill
object
schema_version
Schema Version
string
default: agent_skill.v1
Allowed value: agent_skill.v1
id
required
Id
string
Allowed values: intake connect qualification lookup appointments payments
name
required
Name
string
>= 1 characters <= 100 characters
readiness
required
Readiness
string
Allowed values: ready needs_setup temporarily_unavailable not_enabled
reason
required
Reason
string
>= 1 characters <= 500 characters
effect_owner
required
Effect Owner
string
Allowed values: vocapable carrier tenant_integration merchant
completion_evidence
required
Completion Evidence
string
>= 1 characters <= 300 characters
setup_path
required
Setup Path
string
<= 300 characters /^/[a-zA-Z0-9_/?.=&%-]+$/
enabled_tools
Enabled Tools
Array<string>
<= 20 items
reason_codes
Reason Codes
Array<string>
<= 20 items
execution_rechecks_required
Execution Rechecks Required
boolean
default: true
Example
{
  "skills": [
    {
      "schema_version": "agent_skill.v1",
      "id": "intake",
      "readiness": "ready",
      "effect_owner": "vocapable",
      "execution_rechecks_required": true
    }
  ]
}

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