Introduction
Agent Setup configures the Vini agent for a rooftop and works through the "Agent Setup" checklist tasks. First, load the option lists that fill the agent form: voices, avatars and languages. Then work through the tasks in order: Agent Customization (create or update the agent), Assign Number, Sales Policies, Upload Call Transcripts / Recordings and, for the receptionist only, Chatbot Script.
This stage is done once per agent. Mark each task done with the agent's segmentName. The segmentName values are listed in the Checklist introduction.
| Endpoint | Method and path | What it does |
|---|---|---|
| Browse the voice library | GET /conversation/tts/voices/library | Returns one page of voices to choose from. |
| List avatars | GET /conversation/avatars | Returns the avatars you can pick for the agent. |
| List voice languages | GET /conversation/tts/languages | Returns every language the agent can speak. |
| Get an agent | GET /conversation/agents/team/{teamId}/enterprise/{enterpriseId}/agent-mapping/{teamAgentMappingId} | Returns one existing agent's saved settings and voice. |
| Create an agent | POST /console/v1/product-onboarding/vini/agent (no agentId) | Creates the rooftop's agent for one agent type. |
| Update an agent | POST /console/v1/product-onboarding/vini/agent (with agentId) | Changes an existing agent's settings. |
| List agents | GET /conversation/agents/team/{teamId}/onboarded-agents | Returns every active agent on a rooftop, with its phone number. |
| Assign a phone number | POST /console/v1/telephony/phone-numbers | Buys a phone number and attaches it to one agent. |
| Get the agent config | GET /central-config/v1/vini-config/agent-config | Returns the rooftop-wide agent settings, including sales and service policies. |
| Save the agent config | POST /central-config/v1/vini-config/agent-config | Creates or partly updates the rooftop-wide agent settings. |
| Upload call transcripts or recordings | POST /console/v1/product-onboarding/vini/call-transcripts-recordings/files | Uploads the dealer's sample call files to storage. |
| List chatbot scripts | GET /central-config/v1/smartview-scripts | Returns saved website scripts, one page at a time. |
| Save a chatbot script | POST /central-config/v1/integration | Creates or updates the website script that loads the receptionist chatbot. |
Order to call them
- Load the form options: List voice languages, then Browse the voice library and List avatars.
- Agent Customization: Create an agent. If the agent already exists, Get an agent and then Update an agent.
- Assign Number: List agents to find the agent and check for a number, then Assign a phone number if it has none.
- Sales Policies: Get the agent config, then Save the agent config.
- Upload Call Transcripts / Recordings: Upload call transcripts or recordings, then save the returned URLs with Save readiness answers.
- Chatbot Script (receptionist only): List chatbot scripts, then Save a chatbot script if the rooftop's website has none.
Which save completes which task
| Checklist task | Mark done as (taskName) | Save call | Marked done by the console UI |
|---|---|---|---|
| Agent customization | Agent Customization | Create an agent or Update an agent | Yes, after every successful save. |
| Assign phone number | Assign Number | Assign a phone number | Yes, after a successful purchase. Not called when the agent already has a number, because the UI then skips the purchase. |
| Sales policies | Sales Policies | Save the agent config | No call from the console UI. These pages are edited in a separate settings app; whether that app marks the task done is to be confirmed. |
| Call transcripts and recordings | Upload Call Transcripts / Recordings | Upload call transcripts or recordings, then Save readiness answers | Yes, after both calls. |
| Chatbot script (receptionist only) | None | Save a chatbot script | No. The task counts as done once a script exists: the UI shows it done when List chatbot scripts returns a script with a scriptUrl. Nothing is written to the checklist. |
The console UI marks tasks done with Mark a task done. segmentName is the tab's segment: inboundSales or outboundSales for the sales agents.
Authentication
Most calls need the Bearer token of a signed-in user, sent as Authorization: Bearer YOUR_TOKEN. The token is checked with the identity service. Every path starts with https://api.spyne.ai.
Sales pages
This section covers the sales agents only. Everything except policies is common to every agent. The sales page is Save sales policies: the entityConfig.sales section, marked done as Sales Policies.
Updated about 1 hour ago