Publish voice-agent draft - Sendora

POST

/

api

/

v1

/

public

/

voice-agents

/

{agent_id}

/

publish

cURL

curl -X POST 'https://api.sendora.ai/api/v1/public/voice-agents/YOUR_ID/publish' -H "X-API-Key: $SENDORA_API_KEY" -H "Content-Type: application/json" \
  -d '{"confirmation_id":"example"}'

import requests

url = 'https://api.sendora.ai/api/v1/public/voice-agents/YOUR_ID/publish'
headers = {'X-API-Key': '$SENDORA_API_KEY'}
response = requests.post(url, headers=headers, json={'confirmation_id': 'example'})
response.raise_for_status()
print(response.json())

const response = await fetch("https://api.sendora.ai/api/v1/public/voice-agents/YOUR_ID/publish", {
  method: "POST",
  headers: { 'X-API-Key': process.env.SENDORA_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({"confirmation_id": "example"}),
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

req, err := http.NewRequest("POST", "https://api.sendora.ai/api/v1/public/voice-agents/YOUR_ID/publish", bytes.NewBufferString(`{"confirmation_id": "example"}`))
if err != nil { log.Fatal(err) }
req.Header.Set("X-API-Key", os.Getenv("SENDORA_API_KEY"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "name": "<string>",
  "direction": "outbound",
  "display_name": "<string>",
  "first_message": "",
  "is_active": false,
  "ready": false,
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Customer API key created in the Sendora dashboard.

Headers

X-API-Key

string | null

Authorization

string | null

Path Parameters

agent_id

string

required

The voice agent's id: the id from List voice agents. It is also the last part of that page's address in the app.

Body

application/json

confirmation_id

string

required

The confirmation value returned by the previous publish attempt, sent back to confirm it.

Response

Successful Response

Deliberately minimal public representation of a voice agent.

The authenticated operator API returns the full configuration, but public API keys must not receive system prompts, tool definitions, tenant IDs, or connected service resource identifiers as an incidental side effect of listing an agent. Configuration is accepted on write requests but is never echoed.

created_at

string<date-time>

required

Created at returned by the Sendora API.

id

string

required

The voice agent's id. Pass it to any endpoint that takes agent_id.

name

string

required

Name returned by the Sendora API.

direction

string

default:outbound

Direction returned by the Sendora API.

display_name

string | null

Display name returned by the Sendora API.

first_message

string

default:""

First message returned by the Sendora API.

is_active

boolean

default:false

Is active returned by the Sendora API.

ready

boolean

default:false

Ready returned by the Sendora API.

updated_at

string<date-time> | null

Updated at returned by the Sendora API.

cURL

curl -X POST 'https://api.sendora.ai/api/v1/public/voice-agents/YOUR_ID/publish' -H "X-API-Key: $SENDORA_API_KEY" -H "Content-Type: application/json" \
  -d '{"confirmation_id":"example"}'

import requests

url = 'https://api.sendora.ai/api/v1/public/voice-agents/YOUR_ID/publish'
headers = {'X-API-Key': '$SENDORA_API_KEY'}
response = requests.post(url, headers=headers, json={'confirmation_id': 'example'})
response.raise_for_status()
print(response.json())

const response = await fetch("https://api.sendora.ai/api/v1/public/voice-agents/YOUR_ID/publish", {
  method: "POST",
  headers: { 'X-API-Key': process.env.SENDORA_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({"confirmation_id": "example"}),
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

req, err := http.NewRequest("POST", "https://api.sendora.ai/api/v1/public/voice-agents/YOUR_ID/publish", bytes.NewBufferString(`{"confirmation_id": "example"}`))
if err != nil { log.Fatal(err) }
req.Header.Set("X-API-Key", os.Getenv("SENDORA_API_KEY"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "name": "<string>",
  "direction": "outbound",
  "display_name": "<string>",
  "first_message": "",
  "is_active": false,
  "ready": false,
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}