Reference

Tts Audio

client.tts.audio.speech({ ...params }) -> Speechify.GetSpeechResponse

📝 Description

Gets the speech data for the given input

🔌 Usage

await client.tts.audio.speech({
    input: "input",
    voiceId: "voice_id",
});

⚙️ Parameters

request: Speechify.tts.GetSpeechRequest

requestOptions: Audio.RequestOptions

client.tts.audio.stream({ ...params }) -> stream.Readable

📝 Description

Gets the stream speech for the given input

🔌 Usage

await client.tts.audio.stream({
    accept: "audio/mpeg",
    input: "input",
    language: undefined,
    model: undefined,
    options: undefined,
    voiceId: "voice_id",
});

⚙️ Parameters

request: Speechify.tts.GetStreamRequest

requestOptions: Audio.RequestOptions

Tts Auth

client.tts.auth.createAccessToken({ ...params }) -> Speechify.AccessToken

📝 Description

WARNING: This endpoint is deprecated. Create a new API token for the logged in user.

🔌 Usage

await client.tts.auth.createAccessToken({
    grantType: "client_credentials",
});

⚙️ Parameters

request: Speechify.tts.CreateAccessTokenRequest

requestOptions: Auth.RequestOptions

Tts Voices

client.tts.voices.list() -> Speechify.GetVoice[]

📝 Description

Gets the list of voices available for the user

🔌 Usage

await client.tts.voices.list();

⚙️ Parameters

requestOptions: Voices.RequestOptions

client.tts.voices.create({ ...params }) -> Speechify.CreatedVoice

📝 Description

Create a personal (cloned) voice for the user

🔌 Usage

await client.tts.voices.create({
    sample: fs.createReadStream("/path/to/your/file"),
    name: "name",
    gender: "male",
    consent: "consent",
});

⚙️ Parameters

request: Speechify.tts.CreateVoicesRequest

requestOptions: Voices.RequestOptions

client.tts.voices.delete(id, { ...params }) -> void

📝 Description

Delete a personal (cloned) voice

🔌 Usage

await client.tts.voices.delete("id");

⚙️ Parameters

id: string — The ID of the voice to delete

request: Speechify.tts.DeleteVoicesRequest

requestOptions: Voices.RequestOptions

client.tts.voices.downloadSample(id, { ...params }) -> stream.Readable

📝 Description

Download a personal (cloned) voice sample

🔌 Usage

await client.tts.voices.downloadSample("id");

⚙️ Parameters

id: string — The ID of the voice to download sample for

request: Speechify.tts.DownloadSampleVoicesRequest

requestOptions: Voices.RequestOptions

Tts Agents

client.tts.agents.list() -> Speechify.ListAgentsResponse

📝 Description

List voice agents owned by the caller.

🔌 Usage

await client.tts.agents.list();

⚙️ Parameters

requestOptions: Agents.RequestOptions

client.tts.agents.create({ ...params }) -> Speechify.Agent

📝 Description

Create a voice agent.

🔌 Usage

await client.tts.agents.create({
    name: "name",
    voiceId: "voice_id",
});

⚙️ Parameters

request: Speechify.tts.CreateAgentRequest

requestOptions: Agents.RequestOptions

client.tts.agents.get(id, { ...params }) -> Speechify.Agent

📝 Description

Retrieve a voice agent by ID.

🔌 Usage

await client.tts.agents.get("id");

⚙️ Parameters

id: string

request: Speechify.tts.GetAgentsRequest

requestOptions: Agents.RequestOptions

client.tts.agents.delete(id, { ...params }) -> void

📝 Description

Delete a voice agent. Conversations and attached tools remain.

🔌 Usage

await client.tts.agents.delete("id");

⚙️ Parameters

id: string

request: Speechify.tts.DeleteAgentsRequest

requestOptions: Agents.RequestOptions

client.tts.agents.update(id, { ...params }) -> Speechify.Agent

📝 Description

Update a voice agent. Only fields present on the request body are changed.

🔌 Usage

await client.tts.agents.update("id");

⚙️ Parameters

id: string

request: Speechify.tts.UpdateAgentRequest

requestOptions: Agents.RequestOptions

client.tts.agents.listTools(id, { ...params }) -> Speechify.ListToolsResponse

📝 Description

List tools currently attached to the agent.

🔌 Usage

await client.tts.agents.listTools("id");

⚙️ Parameters

id: string

request: Speechify.tts.ListToolsAgentsRequest

requestOptions: Agents.RequestOptions

client.tts.agents.attachTool(id, toolId, { ...params }) -> void

📝 Description

Attach an existing tool to the agent so the LLM can call it.

🔌 Usage

await client.tts.agents.attachTool("id", "toolId");

⚙️ Parameters

id: string

toolId: string

request: Speechify.tts.AttachToolAgentsRequest

requestOptions: Agents.RequestOptions

client.tts.agents.detachTool(id, toolId, { ...params }) -> void

📝 Description

Detach a tool from the agent.

🔌 Usage

await client.tts.agents.detachTool("id", "toolId");

⚙️ Parameters

id: string

toolId: string

request: Speechify.tts.DetachToolAgentsRequest

requestOptions: Agents.RequestOptions

client.tts.agents.getEvaluationConfig(id, { ...params }) -> Speechify.EvaluationConfig

📝 Description

Retrieve the agent's post-call evaluation criteria + data-collection config.

🔌 Usage

await client.tts.agents.getEvaluationConfig("id");

⚙️ Parameters

id: string

request: Speechify.tts.GetEvaluationConfigAgentsRequest

requestOptions: Agents.RequestOptions

client.tts.agents.updateEvaluationConfig(id, { ...params }) -> Speechify.EvaluationConfig

📝 Description

Replace the agent's evaluation criteria + data-collection fields.

🔌 Usage

await client.tts.agents.updateEvaluationConfig("id", {
    criteria: [
        {
            id: "id",
            name: "name",
            description: "description",
        },
    ],
    dataCollection: [
        {
            key: "key",
            description: "description",
            type: "string",
        },
    ],
});

⚙️ Parameters

id: string

request: Speechify.tts.UpdateEvaluationConfigRequest

requestOptions: Agents.RequestOptions

client.tts.agents.getDynamicVariables(id, { ...params }) -> Speechify.ListDynamicVariablesResponse

📝 Description

Retrieve the agent's customer-scope dynamic variables and the read-only catalogue of reserved system__* keys. The system variables list is provided so editor UIs can render the reference list without maintaining a client-side copy of the catalogue.

🔌 Usage

await client.tts.agents.getDynamicVariables("id");

⚙️ Parameters

id: string

request: Speechify.tts.GetDynamicVariablesAgentsRequest

requestOptions: Agents.RequestOptions

client.tts.agents.updateDynamicVariables(id, { ...params }) -> Speechify.ListDynamicVariablesResponse

📝 Description

Replace the agent's customer-scope dynamic variable definitions. The supplied list overwrites the stored list wholesale (same semantics as updateEvaluationConfig). Pass an empty array to clear all variables. Up to 20 variables per agent. Keys must match [a-zA-Z0-9_]+ and must not start with the reserved system__ prefix.

🔌 Usage

await client.tts.agents.updateDynamicVariables("id", {
    variables: [
        {
            key: "product_name",
            type: "string",
            default: "Speechify",
            description: "Product the agent is supporting.",
        },
        {
            key: "support_tier",
            type: "number",
            default: 1,
        },
        {
            key: "account_metadata",
            type: "json",
            description: "Arbitrary account context injected into tool bodies.",
        },
    ],
});

⚙️ Parameters

id: string

request: Speechify.tts.UpdateDynamicVariablesRequest

requestOptions: Agents.RequestOptions

client.tts.agents.createConversation(id, { ...params }) -> Speechify.CreateConversationResponse

📝 Description

Start a new voice conversation with the agent. Returns a realtime voice session + short-lived client token so the caller can connect the audio pipeline directly. The agent is dispatched server-side; no additional client action required.

Pass dynamic_variables to supply per-session values that override the agent's stored variable defaults for this one conversation. Keys in the system__ namespace are rejected at this boundary.

🔌 Usage

await client.tts.agents.createConversation("id");

⚙️ Parameters

id: string

request: Speechify.tts.CreateConversationRequest

requestOptions: Agents.RequestOptions

client.tts.agents.createSession(id, { ...params }) -> Speechify.CreateConversationResponse

📝 Description

Mint a realtime voice session for the given agent. Widget-friendly counterpart to createConversation — same response shape, dual authentication:

Authenticated (Bearer): works for any agent the caller owns. Typical server-to-server flow where the embedding site's backend mints a token and hands it to the browser so the API key never reaches the client.
Unauthenticated: works only when agent.is_public = true AND the request's Origin header matches agent.allowed_origins (or that list is empty). When agent.hostname_allowlist is non-empty, the Origin hostname must additionally be a member of that list. Used directly by the <speechify-agent> web component.

Responds with the same CreateConversationResponse as createConversation.

🔌 Usage

await client.tts.agents.createSession("id");

⚙️ Parameters

id: string

request: Speechify.tts.CreateSessionRequest

requestOptions: Agents.RequestOptions

client.tts.agents.listAgentKnowledgeBases(id, { ...params }) -> Speechify.ListKnowledgeBasesResponse

📝 Description

List knowledge bases attached to an agent.

🔌 Usage

await client.tts.agents.listAgentKnowledgeBases("id");

⚙️ Parameters

id: string

request: Speechify.tts.ListAgentKnowledgeBasesAgentsRequest

requestOptions: Agents.RequestOptions

client.tts.agents.attachKnowledgeBase(id, kbId, { ...params }) -> void

📝 Description

Attach a knowledge base to an agent. The search_knowledge tool is auto-registered on the next conversation and can only query the attached knowledge bases.

🔌 Usage

await client.tts.agents.attachKnowledgeBase("id", "kbId");

⚙️ Parameters

id: string

kbId: string

request: Speechify.tts.AttachKnowledgeBaseAgentsRequest

requestOptions: Agents.RequestOptions

client.tts.agents.detachKnowledgeBase(id, kbId, { ...params }) -> void

📝 Description

Detach a knowledge base from an agent.

🔌 Usage

await client.tts.agents.detachKnowledgeBase("id", "kbId");

⚙️ Parameters

id: string

kbId: string

request: Speechify.tts.DetachKnowledgeBaseAgentsRequest

requestOptions: Agents.RequestOptions

client.tts.agents.listMemories(id, { ...params }) -> Speechify.ListMemoriesResponse

📝 Description

List per-caller memories extracted for an agent. Memories are written post-call by the built-in extractor when memory_enabled is true on the agent; the list is sorted newest-first.

🔌 Usage

await client.tts.agents.listMemories("id");

⚙️ Parameters

id: string

request: Speechify.tts.ListMemoriesAgentsRequest

requestOptions: Agents.RequestOptions

client.tts.agents.deleteMemoriesByCaller(id, { ...params }) -> Speechify.DeleteMemoriesByCallerResponse

📝 Description

Delete every memory ever extracted for a specific caller on this agent. Privacy / GDPR surface. Returns the count of rows soft-deleted; rows become permanently unreachable immediately and are hard-deleted by the retention job after the tenant's configured retention window.

🔌 Usage

await client.tts.agents.deleteMemoriesByCaller("id", {
    agentId: "agent_id",
    callerIdentity: "caller_identity",
});

⚙️ Parameters

id: string

request: Speechify.tts.DeleteMemoriesByCallerRequest

requestOptions: Agents.RequestOptions

client.tts.agents.listTests(id, { ...params }) -> Speechify.ListAgentTestsResponse

📝 Description

List all tests configured for the agent. Each entry includes the most recent run so the console can render pass/fail badges without an extra round-trip.

🔌 Usage

await client.tts.agents.listTests("id");

⚙️ Parameters

id: string — Agent ID.

request: Speechify.tts.ListTestsAgentsRequest

requestOptions: Agents.RequestOptions

client.tts.agents.createTest(id, { ...params }) -> Speechify.AgentTest

📝 Description

Create a new test for the agent.

🔌 Usage

await client.tts.agents.createTest("id", {
    name: "Greet the caller by name",
    description: "Agent should greet the caller using their name when provided.",
    type: "scenario",
    config: {
        context: "The caller says: Hi, I'm Alice.",
        successCriteria: "The agent greets Alice by name.",
        successExamples: ["Hi Alice! How can I help you today?"],
        failureExamples: ["Hello! How can I help you?"],
    },
});

⚙️ Parameters

id: string — Agent ID.

request: Speechify.tts.CreateAgentTestRequest

requestOptions: Agents.RequestOptions

client.tts.agents.runAllTests(id, { ...params }) -> Speechify.RunAgentTestsResponse

📝 Description

Enqueue runs for every test on the agent concurrently. Up to 50 tests are dispatched in one call. Each returned run starts in queued status; poll GET /v1/test-runs/{id} for the terminal result.

🔌 Usage

await client.tts.agents.runAllTests("id");

⚙️ Parameters

id: string — Agent ID.

request: Speechify.tts.RunAllTestsAgentsRequest

requestOptions: Agents.RequestOptions

client.tts.agents.getTest(id, { ...params }) -> Speechify.AgentTest

📝 Description

Retrieve a test by ID.

🔌 Usage

await client.tts.agents.getTest("id");

⚙️ Parameters

id: string — Test ID.

request: Speechify.tts.GetTestAgentsRequest

requestOptions: Agents.RequestOptions

client.tts.agents.deleteTest(id, { ...params }) -> void

📝 Description

Delete a test and all its run history.

🔌 Usage

await client.tts.agents.deleteTest("id");

⚙️ Parameters

id: string — Test ID.

request: Speechify.tts.DeleteTestAgentsRequest

requestOptions: Agents.RequestOptions

client.tts.agents.updateTest(id, { ...params }) -> Speechify.AgentTest

📝 Description

Update a test. Only fields present on the request body are changed.

🔌 Usage

await client.tts.agents.updateTest("id");

⚙️ Parameters

id: string — Test ID.

request: Speechify.tts.UpdateAgentTestRequest

requestOptions: Agents.RequestOptions

client.tts.agents.listTestRuns(id, { ...params }) -> Speechify.ListAgentTestRunsResponse

📝 Description

List the run history for a test, newest first.

🔌 Usage

await client.tts.agents.listTestRuns("id");

⚙️ Parameters

id: string — Test ID.

request: Speechify.tts.ListTestRunsAgentsRequest

requestOptions: Agents.RequestOptions

client.tts.agents.runTest(id, { ...params }) -> Speechify.AgentTestRun

📝 Description

Enqueue a single run of the test. The returned run starts in queued status. Poll GET /v1/test-runs/{id} until the status reaches a terminal state (passed, failed, or error).

🔌 Usage

await client.tts.agents.runTest("id");

⚙️ Parameters

id: string — Test ID.

request: Speechify.tts.RunTestAgentsRequest

requestOptions: Agents.RequestOptions

client.tts.agents.getTestRun(id, { ...params }) -> Speechify.AgentTestRun

📝 Description

Retrieve a single test run by ID. Poll this endpoint until status reaches a terminal state (passed, failed, or error). The result field is populated on terminal states.

🔌 Usage

await client.tts.agents.getTestRun("id");

⚙️ Parameters

id: string — Test run ID.

request: Speechify.tts.GetTestRunAgentsRequest

requestOptions: Agents.RequestOptions

client.tts.agents.listAllTests({ ...params }) -> Speechify.ListTestsResponse

📝 Description

Workspace-wide list of tests across every agent the caller owns. Supports filters (agent, type, last-run status, folder), full-text search on name/description, and cursor pagination. Each row carries its newest run and attached agent IDs so the list renders without N+1 round-trips.

🔌 Usage

await client.tts.agents.listAllTests();

⚙️ Parameters

request: Speechify.tts.ListAllTestsAgentsRequest

requestOptions: Agents.RequestOptions

client.tts.agents.getTestStats({ ...params }) -> Speechify.TestStats

📝 Description

Aggregate pass-rate metrics over the last N days. Returns dense daily buckets (one entry per day, zero-filled) plus totals and a per-type breakdown. Powers the header chart on the global tests page. Default window is 30 days, max 90.

🔌 Usage

await client.tts.agents.getTestStats();

⚙️ Parameters

request: Speechify.tts.GetTestStatsAgentsRequest

requestOptions: Agents.RequestOptions

client.tts.agents.runTestsBatch({ ...params }) -> Speechify.RunBatchResponse

📝 Description

Queue runs for every (test, agent) pair in the body. Entries without an agent_id fan out to every agent the test is attached to. Total expanded runs are capped at 100 per call. Each entry in the response is a queued run; poll GET /v1/test-runs/{id} for each.

🔌 Usage

await client.tts.agents.runTestsBatch({
    entries: [
        {
            testId: "test_id",
        },
    ],
});

⚙️ Parameters

request: Speechify.tts.RunBatchRequest

requestOptions: Agents.RequestOptions

client.tts.agents.listTestAttachments(id, { ...params }) -> Speechify.ListAgentTestAttachmentsResponse

📝 Description

List every agent a test is attached to.

🔌 Usage

await client.tts.agents.listTestAttachments("id");

⚙️ Parameters

id: string

request: Speechify.tts.ListTestAttachmentsAgentsRequest

requestOptions: Agents.RequestOptions

client.tts.agents.attachTest(id, agentId, { ...params }) -> void

📝 Description

Attach a test to an additional agent. After this call, the test will also run as part of that agent's regression suite (and against its prompt + tool config when invoked with agent_id = {agentId}). Idempotent.

🔌 Usage

await client.tts.agents.attachTest("id", "agentId");

⚙️ Parameters

id: string

agentId: string

request: Speechify.tts.AttachTestAgentsRequest

requestOptions: Agents.RequestOptions

client.tts.agents.detachTest(id, agentId, { ...params }) -> void

📝 Description

Detach a test from an agent. The owner agent (the agent the test was authored against) cannot be detached; delete the test instead.

🔌 Usage

await client.tts.agents.detachTest("id", "agentId");

⚙️ Parameters

id: string

agentId: string

request: Speechify.tts.DetachTestAgentsRequest

requestOptions: Agents.RequestOptions

client.tts.agents.moveTest(id, { ...params }) -> void

📝 Description

Move a test into a folder. Pass folder_id: null for root.

🔌 Usage

await client.tts.agents.moveTest("id");

⚙️ Parameters

id: string

request: Speechify.tts.MoveAgentTestRequest

requestOptions: Agents.RequestOptions

client.tts.agents.listTestFolders() -> Speechify.ListAgentTestFoldersResponse

📝 Description

List every test folder the caller owns. Flat list; build the tree client-side.

🔌 Usage

await client.tts.agents.listTestFolders();

⚙️ Parameters

requestOptions: Agents.RequestOptions

client.tts.agents.createTestFolder({ ...params }) -> Speechify.AgentTestFolder

📝 Description

Create a test folder. Max depth is 3.

🔌 Usage

await client.tts.agents.createTestFolder({
    name: "name",
});

⚙️ Parameters

request: Speechify.tts.CreateAgentTestFolderRequest

requestOptions: Agents.RequestOptions

client.tts.agents.deleteTestFolder(id, { ...params }) -> void

📝 Description

Soft-delete a folder. Child tests drop back to root.

🔌 Usage

await client.tts.agents.deleteTestFolder("id");

⚙️ Parameters

id: string

request: Speechify.tts.DeleteTestFolderAgentsRequest

requestOptions: Agents.RequestOptions

client.tts.agents.updateTestFolder(id, { ...params }) -> Speechify.AgentTestFolder

📝 Description

Rename or reparent a test folder. Cycles are rejected.

🔌 Usage

await client.tts.agents.updateTestFolder("id");

⚙️ Parameters

id: string

request: Speechify.tts.UpdateAgentTestFolderRequest

requestOptions: Agents.RequestOptions

Tts Tools

client.tts.tools.list() -> Speechify.ListToolsResponse

📝 Description

List tools owned by the caller.

🔌 Usage

await client.tts.tools.list();

⚙️ Parameters

requestOptions: Tools.RequestOptions

client.tts.tools.create({ ...params }) -> Speechify.Tool

📝 Description

Create a tool. For webhook tools, the response includes the HMAC webhook_secret exactly once — store it immediately; subsequent reads return a masked placeholder.

🔌 Usage

await client.tts.tools.create({
    name: "name",
    description: "description",
    kind: "system",
    config: {
        builtin: "end_call",
    },
});

⚙️ Parameters

request: Speechify.tts.CreateToolRequest

requestOptions: Tools.RequestOptions

client.tts.tools.get(id, { ...params }) -> Speechify.Tool

📝 Description

Retrieve a tool by ID. Webhook secrets are always masked here.

🔌 Usage

await client.tts.tools.get("id");

⚙️ Parameters

id: string

request: Speechify.tts.GetToolsRequest

requestOptions: Tools.RequestOptions

client.tts.tools.delete(id, { ...params }) -> void

📝 Description

Delete a tool. Agents that had it attached get a soft-detach.

🔌 Usage

await client.tts.tools.delete("id");

⚙️ Parameters

id: string

request: Speechify.tts.DeleteToolsRequest

requestOptions: Tools.RequestOptions

client.tts.tools.update(id, { ...params }) -> Speechify.Tool

📝 Description

Update a tool. Tool kind is immutable — create a new tool to change it.

🔌 Usage

await client.tts.tools.update("id");

⚙️ Parameters

id: string

request: Speechify.tts.UpdateToolRequest

requestOptions: Tools.RequestOptions

Tts Conversations

client.tts.conversations.list() -> Speechify.ListConversationsResponse

📝 Description

List conversations owned by the caller, ordered by most recent.

🔌 Usage

await client.tts.conversations.list();

⚙️ Parameters

requestOptions: Conversations.RequestOptions

client.tts.conversations.stats() -> Speechify.ConversationStats

📝 Description

Aggregated counts and averages over the caller's conversations, scoped by the same filters as the list endpoint.

🔌 Usage

await client.tts.conversations.stats();

⚙️ Parameters

requestOptions: Conversations.RequestOptions

client.tts.conversations.get(id, { ...params }) -> Speechify.Conversation

📝 Description

Retrieve a conversation by ID.

🔌 Usage

await client.tts.conversations.get("id");

⚙️ Parameters

id: string

request: Speechify.tts.GetConversationsRequest

requestOptions: Conversations.RequestOptions

client.tts.conversations.listMessages(id, { ...params }) -> Speechify.ListMessagesResponse

📝 Description

Retrieve the full transcript for a conversation, in order.

🔌 Usage

await client.tts.conversations.listMessages("id");

⚙️ Parameters

id: string

request: Speechify.tts.ListMessagesConversationsRequest

requestOptions: Conversations.RequestOptions

client.tts.conversations.listEvaluations(id, { ...params }) -> Speechify.ListEvaluationsResponse

📝 Description

Retrieve post-call evaluation results for a conversation.

🔌 Usage

await client.tts.conversations.listEvaluations("id");

⚙️ Parameters

id: string

request: Speechify.tts.ListEvaluationsConversationsRequest

requestOptions: Conversations.RequestOptions

client.tts.conversations.listMemories(id, { ...params }) -> Speechify.ListMemoriesResponse

📝 Description

List memories extracted from a specific conversation.

🔌 Usage

await client.tts.conversations.listMemories("id");

⚙️ Parameters

id: string

request: Speechify.tts.ListMemoriesConversationsRequest

requestOptions: Conversations.RequestOptions

Tts KnowledgeBases

client.tts.knowledgeBases.list() -> Speechify.ListKnowledgeBasesResponse

📝 Description

List knowledge bases owned by the caller.

🔌 Usage

await client.tts.knowledgeBases.list();

⚙️ Parameters

requestOptions: KnowledgeBases.RequestOptions

client.tts.knowledgeBases.create({ ...params }) -> Speechify.KnowledgeBase

📝 Description

Create a new knowledge base.

🔌 Usage

await client.tts.knowledgeBases.create({
    name: "name",
});

⚙️ Parameters

request: Speechify.tts.CreateKnowledgeBaseRequest

requestOptions: KnowledgeBases.RequestOptions

client.tts.knowledgeBases.get(id, { ...params }) -> Speechify.KnowledgeBase

📝 Description

Retrieve a knowledge base by ID.

🔌 Usage

await client.tts.knowledgeBases.get("id");

⚙️ Parameters

id: string

request: Speechify.tts.GetKnowledgeBasesRequest

requestOptions: KnowledgeBases.RequestOptions

client.tts.knowledgeBases.delete(id, { ...params }) -> void

📝 Description

Soft-delete a knowledge base. Documents and chunks are cascaded.

🔌 Usage

await client.tts.knowledgeBases.delete("id");

⚙️ Parameters

id: string

request: Speechify.tts.DeleteKnowledgeBasesRequest

requestOptions: KnowledgeBases.RequestOptions

client.tts.knowledgeBases.update(id, { ...params }) -> Speechify.KnowledgeBase

📝 Description

Update a knowledge base.

🔌 Usage

await client.tts.knowledgeBases.update("id");

⚙️ Parameters

id: string

request: Speechify.tts.UpdateKnowledgeBaseRequest

requestOptions: KnowledgeBases.RequestOptions

client.tts.knowledgeBases.listDocuments(id, { ...params }) -> Speechify.ListKnowledgeBaseDocumentsResponse

📝 Description

List documents ingested into a knowledge base.

🔌 Usage

await client.tts.knowledgeBases.listDocuments("id");

⚙️ Parameters

id: string

request: Speechify.tts.ListDocumentsKnowledgeBasesRequest

requestOptions: KnowledgeBases.RequestOptions

client.tts.knowledgeBases.uploadDocument(id, { ...params }) -> Speechify.KnowledgeBaseDocument

📝 Description

Upload a document (PDF, plain text, markdown, or HTML) to a knowledge base. The document is extracted, chunked, embedded, and indexed synchronously; expect a few seconds per MB of input. Maximum 10 MB per upload.

🔌 Usage

await client.tts.knowledgeBases.uploadDocument("id", {
    file: fs.createReadStream("/path/to/your/file"),
});

⚙️ Parameters

id: string

request: Speechify.tts.UploadDocumentKnowledgeBasesRequest

requestOptions: KnowledgeBases.RequestOptions

client.tts.knowledgeBases.getDocument(docId, { ...params }) -> Speechify.KnowledgeBaseDocument

📝 Description

Retrieve a document by ID.

🔌 Usage

await client.tts.knowledgeBases.getDocument("docId");

⚙️ Parameters

docId: string

request: Speechify.tts.GetDocumentKnowledgeBasesRequest

requestOptions: KnowledgeBases.RequestOptions

client.tts.knowledgeBases.deleteDocument(docId, { ...params }) -> void

📝 Description

Delete a document and all its chunks.

🔌 Usage

await client.tts.knowledgeBases.deleteDocument("docId");

⚙️ Parameters

docId: string

request: Speechify.tts.DeleteDocumentKnowledgeBasesRequest

requestOptions: KnowledgeBases.RequestOptions

client.tts.knowledgeBases.listChunks(docId, { ...params }) -> Speechify.ListKnowledgeBaseChunksResponse

📝 Description

List the chunks for a document.

🔌 Usage

await client.tts.knowledgeBases.listChunks("docId");

⚙️ Parameters

docId: string

request: Speechify.tts.ListChunksKnowledgeBasesRequest

requestOptions: KnowledgeBases.RequestOptions

client.tts.knowledgeBases.search({ ...params }) -> Speechify.SearchKnowledgeBasesResponse

📝 Description

Semantic search across a caller-owned list of knowledge bases. Returns ranked chunks with source filename and a cosine-similarity score. Limited to 50 results per request.

🔌 Usage

await client.tts.knowledgeBases.search({
    query: "query",
    kbIds: ["kb_ids"],
});

⚙️ Parameters

request: Speechify.tts.SearchKnowledgeBasesRequest

requestOptions: KnowledgeBases.RequestOptions

Tts Memories

client.tts.memories.delete(memoryId, { ...params }) -> void

📝 Description

Soft-delete one memory row.

🔌 Usage

await client.tts.memories.delete("memoryId");

⚙️ Parameters

memoryId: string

request: Speechify.tts.DeleteMemoriesRequest

requestOptions: Memories.RequestOptions

Tts PhoneNumbers

client.tts.phoneNumbers.list() -> unknown

📝 Description

List all phone numbers in the caller's workspace.

🔌 Usage

await client.tts.phoneNumbers.list();

⚙️ Parameters

requestOptions: PhoneNumbers.RequestOptions

client.tts.phoneNumbers.import({ ...params }) -> unknown

📝 Description

Import a phone number into the workspace. The source field determines the provisioning path:

livekit - LiveKit purchases the number on your behalf. US inbound only. Quickest path for local testing.
twilio - Provide your Twilio Account SID, Auth Token, and the E.164 number you already own. We provision an Elastic SIP Trunk on your Twilio account automatically.
byoc - Provide an existing SIP trunk ID. The number is registered against that trunk.

Returns 402 when the workspace has reached the 100-number cap.

🔌 Usage

await client.tts.phoneNumbers.import({
    key: "value",
});

⚙️ Parameters

request: unknown

requestOptions: PhoneNumbers.RequestOptions

client.tts.phoneNumbers.get(id, { ...params }) -> unknown

📝 Description

Retrieve a phone number by ID.

🔌 Usage

await client.tts.phoneNumbers.get("id");

⚙️ Parameters

id: string

request: Speechify.tts.GetPhoneNumbersRequest

requestOptions: PhoneNumbers.RequestOptions

client.tts.phoneNumbers.delete(id, { ...params }) -> void

📝 Description

Delete a phone number from the workspace. For Twilio and LiveKit numbers this also deprovisions the backing SIP trunk and dispatch rule on LiveKit Cloud.

🔌 Usage

await client.tts.phoneNumbers.delete("id");

⚙️ Parameters

id: string

request: Speechify.tts.DeletePhoneNumbersRequest

requestOptions: PhoneNumbers.RequestOptions

client.tts.phoneNumbers.update(id, { ...params }) -> unknown

📝 Description

Update a phone number. Only label and agent_id are mutable; source and e164 are immutable after import. Pass null for agent_id to unbind the number from its current agent.

🔌 Usage

await client.tts.phoneNumbers.update("id", {
    body: {
        key: "value",
    },
});

⚙️ Parameters

id: string

request: Speechify.tts.UpdatePhoneNumbersRequest

requestOptions: PhoneNumbers.RequestOptions

Tts SipTrunks

client.tts.sipTrunks.list() -> unknown

📝 Description

List all SIP trunks in the caller's workspace.

🔌 Usage

await client.tts.sipTrunks.list();

⚙️ Parameters

requestOptions: SipTrunks.RequestOptions

client.tts.sipTrunks.create({ ...params }) -> unknown

📝 Description

Create a SIP trunk. For kind=byoc supply sip_address plus optional digest credentials and IP allowlist. For kind=twilio use ImportPhoneNumber with a twilio spec instead - trunk creation is handled automatically. Returns 402 when the workspace has reached the 20-trunk cap.

🔌 Usage

await client.tts.sipTrunks.create({
    key: "value",
});

⚙️ Parameters

request: unknown

requestOptions: SipTrunks.RequestOptions

client.tts.sipTrunks.get(id, { ...params }) -> unknown

📝 Description

Retrieve a SIP trunk by ID.

🔌 Usage

await client.tts.sipTrunks.get("id");

⚙️ Parameters

id: string

request: Speechify.tts.GetSipTrunksRequest

requestOptions: SipTrunks.RequestOptions

client.tts.sipTrunks.delete(id, { ...params }) -> void

📝 Description

Delete a SIP trunk. This also removes the backing LiveKit inbound trunk, outbound trunk, and dispatch rule if they were provisioned by us. Phone numbers attached to this trunk are left in place but become non-functional until rebound to a new trunk.

🔌 Usage

await client.tts.sipTrunks.delete("id");

⚙️ Parameters

id: string

request: Speechify.tts.DeleteSipTrunksRequest

requestOptions: SipTrunks.RequestOptions

Tts OutboundCalls

client.tts.outboundCalls.create({ ...params }) -> unknown

📝 Description

Place an outbound call from an agent to a phone number. LiveKit originates the SIP INVITE through the outbound trunk bound to the agent's workspace; the agent worker is dispatched into the room automatically.

The response is returned as soon as LiveKit accepts the INVITE. Poll GET /v1/conversations/{conversation_id} for status transitions: pending → active (answered) → completed.

Requires a Twilio or BYOC trunk. LiveKit-native numbers are inbound-only.

🔌 Usage

await client.tts.outboundCalls.create({
    key: "value",
});

⚙️ Parameters

request: unknown

requestOptions: OutboundCalls.RequestOptions

Tts Workspaces

client.tts.workspaces.list() -> Speechify.TenantsListResponse

📝 Description

List every workspace the authenticated user belongs to. Powers the workspace switcher.

🔌 Usage

await client.tts.workspaces.list();

⚙️ Parameters

requestOptions: Workspaces.RequestOptions

client.tts.workspaces.create({ ...params }) -> Speechify.Tenant

📝 Description

Create a new workspace with the authenticated user as owner. The caller must switch their active workspace client-side via the X-Tenant-ID header to act on the new tenant.

🔌 Usage

await client.tts.workspaces.create();

⚙️ Parameters

request: Speechify.tts.CreateWorkspaceRequest

requestOptions: Workspaces.RequestOptions

client.tts.workspaces.getCurrent() -> Speechify.Tenant

📝 Description

Retrieve the workspace currently selected by the caller (via X-Tenant-ID or auto-resolved).

🔌 Usage

await client.tts.workspaces.getCurrent();

⚙️ Parameters

requestOptions: Workspaces.RequestOptions

client.tts.workspaces.updateCurrent({ ...params }) -> Speechify.Tenant

📝 Description

Rename the current workspace. Owner or admin only.

🔌 Usage

await client.tts.workspaces.updateCurrent({
    name: "name",
});

⚙️ Parameters

request: Speechify.tts.UpdateWorkspaceRequest

requestOptions: Workspaces.RequestOptions

client.tts.workspaces.listMembers() -> Speechify.MembersListResponse

📝 Description

List every member of the current workspace. Any member may call this.

🔌 Usage

await client.tts.workspaces.listMembers();

⚙️ Parameters

requestOptions: Workspaces.RequestOptions

client.tts.workspaces.leave() -> void

📝 Description

Remove the authenticated caller from the current workspace. Refused with 409 when the caller is the last owner — promote another member to owner first.

🔌 Usage

await client.tts.workspaces.leave();

⚙️ Parameters

requestOptions: Workspaces.RequestOptions

client.tts.workspaces.removeMember(userUid, { ...params }) -> void

📝 Description

Remove a member from the current workspace. Owner or admin only. The caller cannot remove themselves — use POST /v1/tenants/current/members/leave instead.

🔌 Usage

await client.tts.workspaces.removeMember("user_uid");

⚙️ Parameters

userUid: string

request: Speechify.tts.RemoveMemberWorkspacesRequest

requestOptions: Workspaces.RequestOptions

client.tts.workspaces.updateMemberRole(userUid, { ...params }) -> Speechify.Member

📝 Description

Change a member's role. Owner only — admins may add or remove members but may not change roles. Refused with 409 when demoting the last remaining owner.

🔌 Usage

await client.tts.workspaces.updateMemberRole("user_uid", {
    role: "owner",
});

⚙️ Parameters

userUid: string

request: Speechify.tts.UpdateMemberRoleRequest

requestOptions: Workspaces.RequestOptions

client.tts.workspaces.listInvites() -> Speechify.InvitesListResponse

📝 Description

List outstanding invites for the current workspace. Invite tokens are redacted.

🔌 Usage

await client.tts.workspaces.listInvites();

⚙️ Parameters

requestOptions: Workspaces.RequestOptions

client.tts.workspaces.createInvite({ ...params }) -> Speechify.Invite

📝 Description

Create an invite to the current workspace. Owner or admin only. The response contains the invite token ONCE — subsequent list calls redact it.

🔌 Usage

await client.tts.workspaces.createInvite({
    email: "email",
});

⚙️ Parameters

request: Speechify.tts.CreateInviteRequest

requestOptions: Workspaces.RequestOptions

client.tts.workspaces.revokeInvite(id, { ...params }) -> void

📝 Description

Revoke an outstanding invite. Owner or admin only. Idempotent.

🔌 Usage

await client.tts.workspaces.revokeInvite("id");

⚙️ Parameters

id: string

request: Speechify.tts.RevokeInviteWorkspacesRequest

requestOptions: Workspaces.RequestOptions

client.tts.workspaces.acceptInvite(token, { ...params }) -> Speechify.Tenant

📝 Description

Accept a workspace invite. The authenticated caller is joined to the invite's workspace as a member. Expired, revoked, or already-accepted tokens return 404 to avoid token enumeration.

🔌 Usage

await client.tts.workspaces.acceptInvite("token");

⚙️ Parameters

token: string

request: Speechify.tts.AcceptInviteWorkspacesRequest

requestOptions: Workspaces.RequestOptions

client.tts.workspaces.previewInvite(token, { ...params }) -> Speechify.InvitePreview

📝 Description

Preview a workspace invite without authenticating. Returns the workspace name, inviter details, and expiry so the /join/{token} page can render before the recipient signs in. Anyone with the token can already accept, so this endpoint deliberately surfaces the same information a caller would see after accepting. Invalid tokens (unknown, expired, revoked, already-accepted, or pointing at a soft-deleted workspace) collapse to a single 404 to prevent enumeration.

🔌 Usage

await client.tts.workspaces.previewInvite("token");

⚙️ Parameters

token: string

request: Speechify.tts.PreviewInviteWorkspacesRequest

requestOptions: Workspaces.RequestOptions

client.tts.workspaces.transferWorkspaceOwner({ ...params }) -> void

📝 Description

Transfer ownership of the current workspace atomically. Promotes the target member to owner and demotes the caller to admin in a single transaction. Owner-only; admins cannot hand off a role they were never granted. Prefer this over two PATCH calls to /v1/tenants/current/members/{user_uid}: a sole-owner caller cannot demote themselves first without tripping the last-owner guard, which this endpoint sidesteps by promoting before demoting.

🔌 Usage

await client.tts.workspaces.transferWorkspaceOwner({
    userUid: "user_uid",
});

⚙️ Parameters

request: Speechify.tts.TransferOwnershipRequest

requestOptions: Workspaces.RequestOptions

FilesExpand file tree

reference.md

Latest commit

History

reference.md

File metadata and controls

Reference

Tts Audio

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

Tts Auth

📝 Description

🔌 Usage

⚙️ Parameters

Tts Voices

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

Tts Agents

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters