Get agents

StateSet Voice API operation.

GET /api/v1/customer/agent

cURL

curl --request GET \
  --url 'https://api.voice.stateset.com/api/v1/customer/agent' \
  --header "Authorization: Bearer $STATESET_VOICE_API_KEY"

200

{
  "ok": true,
  "agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "agent_name": "string",
  "voice": "eve",
  "greeting": "string",
  "instructions": "Two-person tent, green — replacement for damaged pole set.",
  "realtime_model": "string",
  "business_profile": {
    "business_name": "string",
    "description": "Two-person tent, green — replacement for damaged pole set.",
    "faqs": [
      {
        "answer": null,
        "question": null
      }
    ],
    "hours": "string",
    "location": "string",
    "notes": "Two-person tent, green — replacement for damaged pole set.",
    "services": [
      "string"
    ],
    "transfer_to": "string"
  }
}

StateSet Voice API operation.

Response

object

ok · boolean · required

agent_id · string (uuid) · required

Id of the tenant’s published voice_receptionist agent

agent_name · string,null · required

Display name the agent introduces itself with

voice · string,null · required

Voice id from the voice catalog (see GET /customer/voices)

greeting · string,null · required

Greeting line spoken when a call connects

instructions · string,null · required

System instructions the agent follows

realtime_model · string,null · required

Realtime model the agent runs on

business_profile · BusinessProfile,null · required

Guided business profile when the agent is still wizard-authored, so the app can render the guided form. Null once the customer has hand-edited their instructions and owns them.

Show BusinessProfile

business_name · string · required

Trading name, used in the greeting and throughout the prompt.

description · string,null

One line on what the business does (‘family dental practice’).

faqs · Faq[]

Questions the agent should be able to answer without escalating.

Show Faq

answer · string · required

question · string · required

hours · string,null

Free-text hours (‘Mon-Fri 9-5, closed weekends’).

location · string,null

Address or service area.

notes · string,null

Anything else the owner wants the agent to know or avoid.

services · string[]

Things the business offers; the agent may discuss these.

transfer_to · string,null

E.164 number to transfer a caller to when they ask for a human.

Status codes

Code	Meaning
200	Current receptionist agent configuration: voice, greeting, instructions, realtime model
404	Customer self-serve plane disabled
409	No receptionist agent configured for this tenant

cURL

curl --request GET \
  --url 'https://api.voice.stateset.com/api/v1/customer/agent' \
  --header "Authorization: Bearer $STATESET_VOICE_API_KEY"

200

{
  "ok": true,
  "agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "agent_name": "string",
  "voice": "eve",
  "greeting": "string",
  "instructions": "Two-person tent, green — replacement for damaged pole set.",
  "realtime_model": "string",
  "business_profile": {
    "business_name": "string",
    "description": "Two-person tent, green — replacement for damaged pole set.",
    "faqs": [
      {
        "answer": null,
        "question": null
      }
    ],
    "hours": "string",
    "location": "string",
    "notes": "Two-person tent, green — replacement for damaged pole set.",
    "services": [
      "string"
    ],
    "transfer_to": "string"
  }
}