API Reference

Overview
Agents
- GETAgent List
- POSTCreate Agent
- POSTCreate Card Click Event
- DELDelete Agent
- GETGet Agent By Id
- GETGet Available Agent Stt Providers
- GETGet Available Agent Voices
- GETList Active Agent Labels
- PUTUpdate Agent
Agent testing
- POSTSend New Message
Conversations
- GETConversations List
Sessions
- POSTGenerate Recording Urls
- GETGet A Single Session By Id
- GETSessions List
- GETStream Recording
Session debugging
- GETGet Session Data By Session Id
- GETGet Session Data By Sid
- GETGet Session Tool Call Result By Id
Session labels
- POSTCreate Label
- GETGet Label By Id
- GETSession Labels List
Full session summaries
- GETGet Full Session Summary By Id
Session latency
- GETInspect Latency For Session
Session timeline
- GETGet Session Timeline By Id
Session transcripts
- GETGet Session Transcript By Id
Channels
- POSTCreate Channel
- DELDelete Channel Target
- GETGet Channels
- PUTUpdate Channel
Channel targets
- POSTAssign A Channel Target
- GETAvailable Targets List
- PUTEdit Channel Target
- GETGet A Channel Target
- GETGet Channel Targets
Twilio channels
- GETGet Twilio Channel By Id
Twilio numbers
- POSTAdd Twilio Number
- GETList Twilio Phone Numbers
- PUTUpdate Twilio Number
- POSTVerify Twilio Us A2P Compliance
Outbound campaigns
- POSTCreate Outbound Communication Campaign
- DELDelete Outbound Communication Campaign
- GETGet Outbound Communication Campaign
- GETList Outbound Communication Campaigns
- PUTUpdate Outbound Communication Campaign
Outbound batches
- POSTCreate Outbound Communication Batch
- POSTCreate Outbound Communication Request
- DELDelete Outbound Communication Batch
- POSTDelete Requests By List Of Reference Ids
- GETFetch Outbound Communication Batch Results
- GETGet Outbound Communication Batch
- GETList Outbound Communication Batches
- PUTUpdate Outbound Communication Batch
- POSTUpload Outbound Communication Batch
Prompts
- POSTCreate Prompt
- DELDelete Prompt
- GETGet Prompt By Id
- GETGet Prompt History
- GETGet Supported Llm Configs
- GETPrompt List
- PUTUpdate Prompt
Tools
- POSTCreate Tool
- DELDelete Tool
- GETTool History
- GETTool Info
- GETTool List
- PUTUpdate Tool
Data sources
- POSTCreate Data Source
- DELDelete Data Source
- GETGet Data Source
- GETList Data Sources
- PUTUpdate Data Source
Custom messages
- POSTCreate Custom Message
- GETCustom Messages List
- DELDelete Custom Message
- GETGet Custom Message By Id
- PUTUpdate Custom Message
Bridge phrases
- POSTCreate Bridge Phrases
- DELDelete Bridge Phrases
- GETGet Bridge Phrases
- GETList Bridge Phrases
- PUTUpdate Bridge Phrases
Pronunciations
- DELDelete Pronunciations Dictionary
- GETDownload Pronunciations Csv
- GETGet Pronunciations Dictionary
- GETGet Pronunciations Metadata
- POSTUpload Pronunciations Csv
Voice groups
- POSTCreate Voice Group
- POSTCreate Voice Sample
- DELDelete Voice Group
- GETGet Voice Group
- GETList Voice Groups
- PUTUpdate Voice Group
Insights
- GETInsights List
Insights folders
- POSTCreate Insights Upload Folder
- DELDelete Insights Folder
- GETFetch Insights Upload Files
- GETGet Insights Folder Details
- GETList Insights Upload Folders
- POSTMove Insights Upload Files
- PUTUpdate Insights Folder
- POSTUpload Insights Upload Folder
Insights tools
- POSTCreate Insight Tool Configuration
- DELDelete Insight Tool Configuration
- GETGet Insight Tool Config By Id
- GETGet Insight Tool Definitions
- GETList Insight Tool Configurations
- POSTTest Insights Tool
- PUTUpdate Insights Tool Configuration
Insights workflows
- PUTActivate Insights Workflow
- POSTCreate Insight Workflow
- DELDelete Insights Workflow
- GETGet Insight Workflow By Id
- PUTInactivate Insights Workflow
- GETInsight Workflow Executions Summary
- GETInsight Workflow List
- GETList Insight Workflow Executions
- GETList Insight Workflow Files
- GETList Insight Workflow Sessions
- POSTQueue Insights Workflow For Sessions/Files
- PUTUpdate Insights Workflow
Dashboards
- POSTPost Fetch Info
- POSTPost List Dashboards
Directory
- PUTBulk Load Directory Members
- POSTCreate Directory Member
- DELDelete Directory Member
- GETDirectory Member List
- GETDownload Directory Members
- GETGet Directory Member By Id
- GETGet Directory Member History
- PUTRestore Directory Member
- GETTest Directory Member Extension
- PUTUpdate Directory Member
Events
- GETEvents List
Incidents
- POSTCreate Incident
- DELDelete Incident
- GETGet Incident By Id
- GETGet Organizations
- GETList Incidents
- PUTUpdate Incident
Organizations
- POSTCreate Organization
- DELDelete Current Organization
- GETGet Current Organization
- PUTUpdate Current Organization
SIP IP ranges
- POSTCreate Organization Sip Ip Range
- DELDelete Organization Sip Ip Range
- GETList Organization Sip Ip Ranges
- PUTUpdate Organization Sip Ip Range
Services
- POSTCreate Service
- DELDelete Service
- GETGet Service By Id
- GETService List
- PUTUpdate Service
Data takeouts
- POSTCreate Takeout
- GETGet File
- GETGet Takeout
Users
- POSTCreate User
- DELDelete User
- GETGet User
- GETList Users
- DELRequest Removal Of This Account
- POSTSend User Email
- PUTUpdate User
Roles
- POSTCreate Role
- DELDelete Role
- GETGet Role
- GETList Roles
- PUTUpdate Role
Permissions
- GETList Permissions
Conversation configuration
- GETGet Bridge Phrases Config
- PUTUpdate Bridge Phrases Config
Experiments
- POSTCreate Experiment
- DELDelete Experiment
- GETExperiments List
- GETGet Experiment By Id
- POSTStart Experiment
- POSTStop Experiment
- PUTUpdate Experiment

API Reference

Request Removal Of This Account

Request removal of the account of the user calling this endpoint. Intended for removing trial accounts.

DELETE/api/v1/users/delete_account

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

This endpoint has no declared parameters.

Responses

200Successful Response

application/json

response unspecified required

Response example

string

Code examples

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLE_API_KEY"] ?? "",
});

async function run() {
  const result = await syllableSDK.users.usersDeleteAccount();

  console.log(result);
}

run();

import os
from syllable_sdk import SyllableSDK


with SyllableSDK(
    api_key_header=os.getenv("SYLLABLE_API_KEY", ""),
) as ss_client:

    res = ss_client.users.users_delete_account()

    # Handle response
    print(res)

curl --request DELETE \
  --url 'https://api.syllable.cloud/api/v1/users/delete_account'