Skip to content
Vocapable Developers

Read a receptionist's structured business intelligence draft

GET
/v1/agents/{agent_id}/receptionist-intelligence
curl --request GET \
  --url https://api.vocapable.com/v1/agents/example/receptionist-intelligence \
  --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
ReceptionistIntelligenceSummary
object
id
required
Id
string
agent_definition_id
required
Agent Definition Id
string
current_version
Any of:
integer
draft
required
ReceptionistIntelligenceDraft

The customer-editable intelligence document for one receptionist.

object
business_name
required
Business Name
string
>= 1 characters <= 200 characters
business_summary
required
Business Summary
string
>= 1 characters <= 2000 characters
business_summary_source_refs
Business Summary Source Refs
Array<string>
<= 20 items
locations
Locations
Array<object>
<= 50 items
ReceptionistLocation

A stable business-location reference used by a phone line’s AI policy step.

object
ref
required
Ref
string
/^[a-z][a-z0-9_-]{0,63}$/
name
required
Name
string
>= 1 characters <= 160 characters
address
Any of:
string
<= 500 characters
phone
Any of:
string
<= 64 characters
service_area
Any of:
string
<= 500 characters
facts
Facts
Array<string>
<= 30 items
source_refs
Source Refs
Array<string>
<= 20 items
services
Services
Array<object>
<= 100 items
ReceptionistService

One service the receptionist may describe without inventing availability.

object
name
required
Name
string
>= 1 characters <= 160 characters
description
required
Description
string
>= 1 characters <= 1000 characters
availability_note
Any of:
string
<= 500 characters
source_refs
Source Refs
Array<string>
<= 20 items
pricing_policy
Any of:
string
<= 2000 characters
pricing_policy_source_refs
Pricing Policy Source Refs
Array<string>
<= 20 items
faqs
Faqs
Array<object>
<= 100 items
ReceptionistFaq

An approved caller question and its grounded spoken answer.

object
question
required
Question
string
>= 1 characters <= 500 characters
answer
required
Answer
string
>= 1 characters <= 2000 characters
source_refs
Source Refs
Array<string>
<= 20 items
customer_policies
Customer Policies
Array<object>
<= 100 items
ReceptionistPolicyFact

A named business policy, distinct from platform safety/compliance controls.

object
name
required
Name
string
>= 1 characters <= 160 characters
value
required
Value
string
>= 1 characters <= 2000 characters
source_refs
Source Refs
Array<string>
<= 20 items
supported_intents
Supported Intents
Array<string>
<= 50 items
tone
Any of:
string
<= 500 characters
escalation_rules
Any of:
string
<= 2000 characters
escalation_rules_source_refs
Escalation Rules Source Refs
Array<string>
<= 20 items
prohibited_claims
Prohibited Claims
Array<string>
<= 50 items
approved_actions
Approved Actions
Array<string>
Allowed values: check_calendar book_meeting send_sms send_verification_code verify_identity record_sms_consent take_message open_ticket update_lead record_survey_answer confirm_shift record_shift_response record_qualification schedule_callback transfer_to_human record_optout end_call custom_webhook
updated_at
required
Updated At
string format: date-time
created_at
required
Created At
string format: date-time
Example
{
  "draft": {
    "approved_actions": [
      "check_calendar"
    ]
  }
}

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