reference.md

Reference

client.metricsMetricsGet() -> unknown

📝 Description

Endpoint that serves Prometheus metrics.

🔌 Usage

await client.metricsMetricsGet();

⚙️ Parameters

requestOptions: VocodeClient.RequestOptions

numbers

client.numbers.listNumbers({ ...params }) -> Vocode.PhoneNumberPage

🔌 Usage

await client.numbers.listNumbers();

⚙️ Parameters

request: Vocode.ListNumbersRequest

requestOptions: Numbers.RequestOptions

client.numbers.getNumber({ ...params }) -> Vocode.PhoneNumber

🔌 Usage

await client.numbers.getNumber({
    phoneNumber: "phone_number",
});

⚙️ Parameters

request: Vocode.GetNumberRequest

requestOptions: Numbers.RequestOptions

client.numbers.buyNumber({ ...params }) -> Vocode.PhoneNumber

🔌 Usage

await client.numbers.buyNumber();

⚙️ Parameters

request: Vocode.BuyPhoneNumberRequest

requestOptions: Numbers.RequestOptions

client.numbers.updateNumber({ ...params }) -> Vocode.PhoneNumber

🔌 Usage

await client.numbers.updateNumber({
    phoneNumber: "phone_number",
});

⚙️ Parameters

request: Vocode.UpdateNumberRequest

requestOptions: Numbers.RequestOptions

client.numbers.cancelNumber({ ...params }) -> Vocode.PhoneNumber

🔌 Usage

await client.numbers.cancelNumber({
    phoneNumber: "phone_number",
});

⚙️ Parameters

request: Vocode.CancelNumberRequest

requestOptions: Numbers.RequestOptions

client.numbers.linkNumber({ ...params }) -> Vocode.PhoneNumber

🔌 Usage

await client.numbers.linkNumber({
    phoneNumber: "phone_number",
    telephonyAccountConnection: "telephony_account_connection",
});

⚙️ Parameters

request: Vocode.LinkPhoneNumberRequest

requestOptions: Numbers.RequestOptions

calls

client.calls.listCalls({ ...params }) -> Vocode.CallPage

🔌 Usage

await client.calls.listCalls();

⚙️ Parameters

request: Vocode.ListCallsRequest

requestOptions: Calls.RequestOptions

client.calls.getCall({ ...params }) -> Vocode.Call

🔌 Usage

await client.calls.getCall({
    id: "id",
});

⚙️ Parameters

request: Vocode.GetCallRequest

requestOptions: Calls.RequestOptions

client.calls.endCall({ ...params }) -> Vocode.Call

🔌 Usage

await client.calls.endCall({
    id: "id",
});

⚙️ Parameters

request: Vocode.EndCallRequest

requestOptions: Calls.RequestOptions

client.calls.createCall({ ...params }) -> Vocode.Call

🔌 Usage

await client.calls.createCall({
    fromNumber: "from_number",
    toNumber: "to_number",
    agent: "agent",
});

⚙️ Parameters

request: Vocode.CreateCallRequest

requestOptions: Calls.RequestOptions

client.calls.getRecording({ ...params }) -> stream.Readable

🔌 Usage

await client.calls.getRecording({
    id: "string",
});

⚙️ Parameters

request: Vocode.GetRecordingRequest

requestOptions: Calls.RequestOptions

Usage

client.usage.getUsage() -> Vocode.Usage

🔌 Usage

await client.usage.getUsage();

⚙️ Parameters

requestOptions: Usage.RequestOptions

Actions

client.actions.getAction({ ...params }) -> Vocode.ActionResponseModel

🔌 Usage

await client.actions.getAction({
    id: "id",
});

⚙️ Parameters

request: Vocode.GetActionRequest

requestOptions: Actions.RequestOptions

client.actions.listActions({ ...params }) -> Vocode.ActionPage

🔌 Usage

await client.actions.listActions();

⚙️ Parameters

request: Vocode.ListActionsRequest

requestOptions: Actions.RequestOptions

client.actions.createAction({ ...params }) -> Vocode.ActionResponseModel

🔌 Usage

await client.actions.createAction({
    type: "action_add_to_conference",
    config: {
        phoneNumber: "phone_number",
    },
});

⚙️ Parameters

request: Vocode.ActionParamsRequest

requestOptions: Actions.RequestOptions

client.actions.updateAction({ ...params }) -> Vocode.ActionResponseModel

🔌 Usage

await client.actions.updateAction({
    id: "id",
    body: {
        type: "action_add_to_conference",
    },
});

⚙️ Parameters

request: Vocode.UpdateActionRequest

requestOptions: Actions.RequestOptions

Agents

client.agents.getAgent({ ...params }) -> Vocode.Agent

🔌 Usage

await client.agents.getAgent({
    id: "id",
});

⚙️ Parameters

request: Vocode.GetAgentRequest

requestOptions: Agents.RequestOptions

client.agents.listAgents({ ...params }) -> Vocode.AgentPage

🔌 Usage

await client.agents.listAgents();

⚙️ Parameters

request: Vocode.ListAgentsRequest

requestOptions: Agents.RequestOptions

client.agents.createAgent({ ...params }) -> Vocode.Agent

🔌 Usage

await client.agents.createAgent({
    prompt: "prompt",
    voice: "voice",
});

⚙️ Parameters

request: Vocode.AgentParams

requestOptions: Agents.RequestOptions

client.agents.updateAgent({ ...params }) -> Vocode.Agent

🔌 Usage

await client.agents.updateAgent({
    id: "id",
    body: {},
});

⚙️ Parameters

request: Vocode.UpdateAgentRequest

requestOptions: Agents.RequestOptions

Voices

client.voices.getVoice({ ...params }) -> Vocode.VoiceResponseModel

🔌 Usage

await client.voices.getVoice({
    id: "id",
});

⚙️ Parameters

request: Vocode.GetVoiceRequest

requestOptions: Voices.RequestOptions

client.voices.listVoices({ ...params }) -> Vocode.VoicePage

🔌 Usage

await client.voices.listVoices();

⚙️ Parameters

request: Vocode.ListVoicesRequest

requestOptions: Voices.RequestOptions

client.voices.createVoice({ ...params }) -> Vocode.VoiceResponseModel

🔌 Usage

await client.voices.createVoice({
    type: "voice_azure",
    voiceName: "voice_name",
});

⚙️ Parameters

request: Vocode.VoiceParamsRequest

requestOptions: Voices.RequestOptions

client.voices.updateVoice({ ...params }) -> Vocode.VoiceResponseModel

🔌 Usage

await client.voices.updateVoice({
    id: "id",
    body: {
        type: "voice_azure",
    },
});

⚙️ Parameters

request: Vocode.UpdateVoiceRequest

requestOptions: Voices.RequestOptions

Webhooks

client.webhooks.getWebhook({ ...params }) -> Vocode.Webhook

🔌 Usage

await client.webhooks.getWebhook({
    id: "id",
});

⚙️ Parameters

request: Vocode.GetWebhookRequest

requestOptions: Webhooks.RequestOptions

client.webhooks.listWebhooks({ ...params }) -> Vocode.WebhookPage

🔌 Usage

await client.webhooks.listWebhooks();

⚙️ Parameters

request: Vocode.ListWebhooksRequest

requestOptions: Webhooks.RequestOptions

client.webhooks.createWebhook({ ...params }) -> Vocode.Webhook

🔌 Usage

await client.webhooks.createWebhook({
    subscriptions: [Vocode.EventType.EventMessage],
    url: "url",
});

⚙️ Parameters

request: Vocode.WebhookParams

requestOptions: Webhooks.RequestOptions

client.webhooks.updateWebhook({ ...params }) -> Vocode.Webhook

🔌 Usage

await client.webhooks.updateWebhook({
    id: "id",
    body: {},
});

⚙️ Parameters

request: Vocode.UpdateWebhookRequest

requestOptions: Webhooks.RequestOptions

Prompts

client.prompts.getPrompt({ ...params }) -> Vocode.Prompt

🔌 Usage

await client.prompts.getPrompt({
    id: "id",
});

⚙️ Parameters

request: Vocode.GetPromptRequest

requestOptions: Prompts.RequestOptions

client.prompts.listPrompts({ ...params }) -> Vocode.PromptPage

🔌 Usage

await client.prompts.listPrompts();

⚙️ Parameters

request: Vocode.ListPromptsRequest

requestOptions: Prompts.RequestOptions

client.prompts.createPrompt({ ...params }) -> Vocode.Prompt

🔌 Usage

await client.prompts.createPrompt({});

⚙️ Parameters

request: Vocode.PromptParams

requestOptions: Prompts.RequestOptions

client.prompts.updatePrompt({ ...params }) -> Vocode.Prompt

🔌 Usage

await client.prompts.updatePrompt({
    id: "id",
    body: {},
});

⚙️ Parameters

request: Vocode.UpdatePromptRequest

requestOptions: Prompts.RequestOptions

VectorDatabases

client.vectorDatabases.getVectorDatabase({ ...params }) -> Vocode.PineconeVectorDatabase

🔌 Usage

await client.vectorDatabases.getVectorDatabase({
    id: "id",
});

⚙️ Parameters

request: Vocode.GetVectorDatabaseRequest

requestOptions: VectorDatabases.RequestOptions

client.vectorDatabases.listVectorDatabases({ ...params }) -> Vocode.VectorDatabasePage

🔌 Usage

await client.vectorDatabases.listVectorDatabases();

⚙️ Parameters

request: Vocode.ListVectorDatabasesRequest

requestOptions: VectorDatabases.RequestOptions

client.vectorDatabases.createVectorDatabase({ ...params }) -> Vocode.PineconeVectorDatabase

🔌 Usage

await client.vectorDatabases.createVectorDatabase({
    type: "vector_database_pinecone",
    index: "index",
    apiKey: "api_key",
    apiEnvironment: "api_environment",
});

⚙️ Parameters

request: Vocode.PineconeVectorDatabaseParams

requestOptions: VectorDatabases.RequestOptions

client.vectorDatabases.updateVectorDatabase({ ...params }) -> Vocode.PineconeVectorDatabase

🔌 Usage

await client.vectorDatabases.updateVectorDatabase({
    id: "id",
    body: {
        type: "vector_database_pinecone",
    },
});

⚙️ Parameters

request: Vocode.UpdateVectorDatabaseRequest

requestOptions: VectorDatabases.RequestOptions

AccountConnections

client.accountConnections.getAccountConnection({ ...params }) -> Vocode.AccountConnectionResponseModel

🔌 Usage

await client.accountConnections.getAccountConnection({
    id: "id",
});

⚙️ Parameters

request: Vocode.GetAccountConnectionRequest

requestOptions: AccountConnections.RequestOptions

client.accountConnections.listAccountConnections({ ...params }) -> Vocode.AccountConnectionPage

🔌 Usage

await client.accountConnections.listAccountConnections();

⚙️ Parameters

request: Vocode.ListAccountConnectionsRequest

requestOptions: AccountConnections.RequestOptions

client.accountConnections.createAccountConnection({ ...params }) -> Vocode.AccountConnectionResponseModel

🔌 Usage

await client.accountConnections.createAccountConnection({
    credentials: {
        openaiApiKey: "openai_api_key",
    },
    type: "account_connection_openai",
});

⚙️ Parameters

request: Vocode.AccountConnectionParamsRequest

requestOptions: AccountConnections.RequestOptions

client.accountConnections.updateAccountConnection({ ...params }) -> Vocode.AccountConnectionResponseModel

🔌 Usage

await client.accountConnections.updateAccountConnection({
    id: "id",
    body: {
        type: "account_connection_openai",
    },
});

⚙️ Parameters

request: Vocode.UpdateAccountConnectionRequest

requestOptions: AccountConnections.RequestOptions

client.accountConnections.addToSteeringPool({ ...params }) -> unknown

🔌 Usage

await client.accountConnections.addToSteeringPool({
    id: "id",
    body: undefined,
});

⚙️ Parameters

request: Vocode.AddToSteeringPoolRequest

requestOptions: AccountConnections.RequestOptions

client.accountConnections.removeFromSteeringPool({ ...params }) -> unknown

🔌 Usage

await client.accountConnections.removeFromSteeringPool({
    id: "id",
    phoneNumber: "phone_number",
});

⚙️ Parameters

request: Vocode.RemoveFromSteeringPoolRequest

requestOptions: AccountConnections.RequestOptions