Introduction
Go-Live for service agents: you read and save the rooftop's go-live readiness answers, then switch the agent live (or offline) through the agent upsert call.
| Endpoint | Method and path | What it does |
|---|---|---|
| Get readiness answers | GET /central-config/v1/vini-config/go-live-readiness | Reads the saved readiness answers for one agent type at one rooftop. |
| Save service readiness answers | POST /central-config/v1/vini-config/go-live-readiness | Creates or updates readiness answers, one step at a time. |
| Put an agent live | POST /console/v1/product-onboarding/vini/agent | Sets isOnboarded: true so the agent takes part in routing and outreach. |
| Take an agent offline | POST /console/v1/product-onboarding/vini/agent | Sets isOnboarded: false to pause the agent. Settings are kept. |
Before you start
- Every path starts with
https://api.spyne.ai. - Authenticate with a Bearer token from the signed-in user's session:
Authorization: Bearer YOUR_TOKEN. Get readiness answers is the one route with no auth check. - You need the dealer group (
enterpriseId) and the rooftop (teamId). For agents you also need the team-agent mapping ID (agentId) from Agent Setup.
Service agents
- Get readiness answers to pre-fill the readiness questions.
- Save service readiness answers. The readiness checklist tasks (After Hours, Office Hours, Run First Campaign) are marked done with the task name, for example
After Hours, through Mark a task done in Checklist. - Put an agent live: a POST to
/console/v1/product-onboarding/vini/agentwithagentIdandisOnboarded: true. The endpoint is also covered in Update an agent. - Take an agent offline when the dealer wants to pause.
Readiness answers are a stored questionnaire. They do not gate go-live, and Put an agent live does not check them.
Receptionist
The Receptionist goes live through its own steps, covered in Receptionist Agent.
Service readiness
Readiness answers differ by agent. Everything else on this step is common. Service agents save them with Save service readiness answers: service_inbound: afterHours, officeHoursOverflow. service_outbound: runFirstCampaign only.
Updated about 2 hours ago
Did this page help you?