Skip to content
vocapable.Docs

Read Mobile Agent Draft

GET
/v1/mobile/agents/{agent_id}/draft
curl --request GET \
  --url https://api.vocapable.com/v1/mobile/agents/example/draft \
  --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
MobileAgentDraft
object
id
required
Id
string
name
required
Name
string
use_case
required
Use Case
string
status
required
Status
string
latest_version
required
Any of:
integer
updated_at
required
Updated At
string format: date-time
tools
required
Tools
Array<string>
Allowed values: check_calendar book_meeting send_sms send_verification_code verify_identity record_sms_consent take_message open_ticket update_lead register_caller record_survey_answer confirm_shift record_shift_response record_qualification schedule_callback transfer_to_human connect_to_phone_team get_phone_queue_status request_phone_queue_callback resolve_customer request_customer_verification get_customer_verification_status lookup_customer prepare_payment send_payment_link get_payment_status collect_payment_by_phone record_optout end_call custom_webhook
sms_template_ids
required
Sms Template Ids
Array<string>
handoff_targets
required
Handoff Targets
Array<object>
DirectRepHandoffTarget

One server-resolved, immutable direct-rep target in an agent snapshot.

A write request names only rep_id values. Control-api resolves those ids against active, transfer-enabled tenant reps and persists this compact snapshot so an AgentVersion never follows a later mutable Settings record. A raw destination is deliberately not part of this customer/model/runtime representation.

object
rep_id
required
Rep Id
string
>= 1 characters <= 128 characters
display_name
required
Display Name
string
>= 1 characters <= 200 characters
conversation_settings
required
ConversationSettings

Versioned dialogue policy; language availability is qualified by the speech service.

object
default_language
Default Language
string
default: en
Allowed values: en es
supported_languages
Supported Languages
Array<string>
Allowed values: en es
allow_language_switch
Allow Language Switch
boolean
default: true
action_decision_mode
Action Decision Mode
string
default: auto
Allowed values: auto focused_auto
focused_reply_temperature
Any of:
number
<= 2
focused_action_timeout_seconds
Any of:
number
>= 1 <= 6
speech_pronunciations
Speech Pronunciations
object
<= 16 properties
key
additional properties
string
instructions
required
Any of:
string
tone
required
Any of:
string
custom_behavior_fields
required
Custom Behavior Fields
Array<string>
Allowed values: instructions tone
objectives
required
Objectives
Array<object>
object
key
additional properties
any
max_call_seconds
required
Max Call Seconds
integer
assistant_name
required
Any of:
string
disclosure_config
required
Disclosure Config
object
key
additional properties
string
knowledge_pack_id
required
Any of:
string
knowledge_pack_version
required
Any of:
integer
knowledge_pack_name
required
Any of:
string
stock_voice_id
required
Any of:
string
voice_profile_id
required
Any of:
string
Example
{
  "tools": [
    "check_calendar"
  ],
  "conversation_settings": {
    "default_language": "en",
    "supported_languages": [
      "en"
    ],
    "allow_language_switch": true,
    "action_decision_mode": "auto"
  },
  "custom_behavior_fields": [
    "instructions"
  ]
}

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