reference.md

Reference

Assistants

client.assistants.list({ ...params }) -> Vapi.Assistant[]

🔌 Usage

await client.assistants.list();

⚙️ Parameters

request: Vapi.ListAssistantsRequest

requestOptions: AssistantsClient.RequestOptions

client.assistants.create({ ...params }) -> Vapi.Assistant

🔌 Usage

await client.assistants.create({});

⚙️ Parameters

request: Vapi.CreateAssistantDto

requestOptions: AssistantsClient.RequestOptions

client.assistants.get({ ...params }) -> Vapi.Assistant

🔌 Usage

await client.assistants.get({
    id: "id"
});

⚙️ Parameters

request: Vapi.GetAssistantsRequest

requestOptions: AssistantsClient.RequestOptions

client.assistants.delete({ ...params }) -> Vapi.Assistant

🔌 Usage

await client.assistants.delete({
    id: "id"
});

⚙️ Parameters

request: Vapi.DeleteAssistantsRequest

requestOptions: AssistantsClient.RequestOptions

client.assistants.update({ ...params }) -> Vapi.Assistant

🔌 Usage

await client.assistants.update({
    id: "id"
});

⚙️ Parameters

request: Vapi.UpdateAssistantDto

requestOptions: AssistantsClient.RequestOptions

Squads

client.squads.list({ ...params }) -> Vapi.Squad[]

🔌 Usage

await client.squads.list();

⚙️ Parameters

request: Vapi.ListSquadsRequest

requestOptions: SquadsClient.RequestOptions

client.squads.create({ ...params }) -> Vapi.Squad

🔌 Usage

await client.squads.create({
    members: [{}]
});

⚙️ Parameters

request: Vapi.CreateSquadDto

requestOptions: SquadsClient.RequestOptions

client.squads.get({ ...params }) -> Vapi.Squad

🔌 Usage

await client.squads.get({
    id: "id"
});

⚙️ Parameters

request: Vapi.GetSquadsRequest

requestOptions: SquadsClient.RequestOptions

client.squads.delete({ ...params }) -> Vapi.Squad

🔌 Usage

await client.squads.delete({
    id: "id"
});

⚙️ Parameters

request: Vapi.DeleteSquadsRequest

requestOptions: SquadsClient.RequestOptions

client.squads.update({ ...params }) -> Vapi.Squad

🔌 Usage

await client.squads.update({
    id: "id",
    members: [{}]
});

⚙️ Parameters

request: Vapi.UpdateSquadDto

requestOptions: SquadsClient.RequestOptions

Calls

client.calls.list({ ...params }) -> Vapi.Call[]

🔌 Usage

await client.calls.list();

⚙️ Parameters

request: Vapi.ListCallsRequest

requestOptions: CallsClient.RequestOptions

client.calls.create({ ...params }) -> Vapi.CreateCallsResponse

🔌 Usage

await client.calls.create();

⚙️ Parameters

request: Vapi.CreateCallDto

requestOptions: CallsClient.RequestOptions

client.calls.callControllerFindAllPaginated({ ...params }) -> Vapi.CallPaginatedResponse

🔌 Usage

await client.calls.callControllerFindAllPaginated({
    assistantIdAny: "assistant-1,assistant-2,assistant-3",
    customerNumberAny: "+1234567890,+0987654321"
});

⚙️ Parameters

request: Vapi.CallControllerFindAllPaginatedRequest

requestOptions: CallsClient.RequestOptions

client.calls.get({ ...params }) -> Vapi.Call

🔌 Usage

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

⚙️ Parameters

request: Vapi.GetCallsRequest

requestOptions: CallsClient.RequestOptions

client.calls.delete({ ...params }) -> Vapi.Call

🔌 Usage

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

⚙️ Parameters

request: Vapi.DeleteCallDto

requestOptions: CallsClient.RequestOptions

client.calls.update({ ...params }) -> Vapi.Call

🔌 Usage

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

⚙️ Parameters

request: Vapi.UpdateCallDto

requestOptions: CallsClient.RequestOptions

Chats

client.chats.list({ ...params }) -> Vapi.ChatPaginatedResponse

🔌 Usage

await client.chats.list({
    assistantIdAny: "assistant-1,assistant-2,assistant-3"
});

⚙️ Parameters

request: Vapi.ListChatsRequest

requestOptions: ChatsClient.RequestOptions

client.chats.create({ ...params }) -> Vapi.CreateChatsResponse

📝 Description

Creates a new chat with optional SMS delivery via transport field. Requires at least one of: assistantId/assistant, sessionId, or previousChatId. Note: sessionId and previousChatId are mutually exclusive. Transport field enables SMS delivery with two modes: (1) New conversation - provide transport.phoneNumberId and transport.customer to create a new session, (2) Existing conversation - provide sessionId to use existing session data. Cannot specify both sessionId and transport fields together. The transport.useLLMGeneratedMessageForOutbound flag controls whether input is processed by LLM (true, default) or forwarded directly as SMS (false).

🔌 Usage

await client.chats.create({
    input: "input"
});

⚙️ Parameters

request: Vapi.CreateChatDto

requestOptions: ChatsClient.RequestOptions

client.chats.chatControllerChatsExport({ ...params }) -> void

🔌 Usage

await client.chats.chatControllerChatsExport({
    assistantIdAny: "assistant-1,assistant-2,assistant-3"
});

⚙️ Parameters

request: Vapi.ChatControllerChatsExportRequest

requestOptions: ChatsClient.RequestOptions

client.chats.get({ ...params }) -> Vapi.Chat

🔌 Usage

await client.chats.get({
    id: "id"
});

⚙️ Parameters

request: Vapi.GetChatsRequest

requestOptions: ChatsClient.RequestOptions

client.chats.delete({ ...params }) -> Vapi.Chat

🔌 Usage

await client.chats.delete({
    id: "id"
});

⚙️ Parameters

request: Vapi.DeleteChatsRequest

requestOptions: ChatsClient.RequestOptions

client.chats.createResponse({ ...params }) -> Vapi.CreateResponseChatsResponse

🔌 Usage

await client.chats.createResponse({
    input: "input"
});

⚙️ Parameters

request: Vapi.OpenAiResponsesRequest

requestOptions: ChatsClient.RequestOptions

Campaigns

client.campaigns.campaignControllerFindAll({ ...params }) -> Vapi.CampaignPaginatedResponse

🔌 Usage

await client.campaigns.campaignControllerFindAll();

⚙️ Parameters

request: Vapi.CampaignControllerFindAllRequest

requestOptions: CampaignsClient.RequestOptions

client.campaigns.campaignControllerCreate({ ...params }) -> Vapi.Campaign

🔌 Usage

await client.campaigns.campaignControllerCreate({
    name: "Q2 Sales Campaign"
});

⚙️ Parameters

request: Vapi.CreateCampaignDto

requestOptions: CampaignsClient.RequestOptions

client.campaigns.campaignControllerFindOne({ ...params }) -> Vapi.Campaign

🔌 Usage

await client.campaigns.campaignControllerFindOne({
    id: "id"
});

⚙️ Parameters

request: Vapi.CampaignControllerFindOneRequest

requestOptions: CampaignsClient.RequestOptions

client.campaigns.campaignControllerRemove({ ...params }) -> Vapi.Campaign

🔌 Usage

await client.campaigns.campaignControllerRemove({
    id: "id"
});

⚙️ Parameters

request: Vapi.CampaignControllerRemoveRequest

requestOptions: CampaignsClient.RequestOptions

client.campaigns.campaignControllerUpdate({ ...params }) -> Vapi.Campaign

🔌 Usage

await client.campaigns.campaignControllerUpdate({
    id: "id"
});

⚙️ Parameters

request: Vapi.UpdateCampaignDto

requestOptions: CampaignsClient.RequestOptions

Sessions

client.sessions.list({ ...params }) -> Vapi.SessionPaginatedResponse

🔌 Usage

await client.sessions.list({
    assistantIdAny: "assistant-1,assistant-2,assistant-3",
    customerNumberAny: "+1234567890,+0987654321"
});

⚙️ Parameters

request: Vapi.ListSessionsRequest

requestOptions: SessionsClient.RequestOptions

client.sessions.create({ ...params }) -> Vapi.Session

🔌 Usage

await client.sessions.create();

⚙️ Parameters

request: Vapi.CreateSessionDto

requestOptions: SessionsClient.RequestOptions

client.sessions.sessionControllerSessionsExport({ ...params }) -> void

🔌 Usage

await client.sessions.sessionControllerSessionsExport({
    assistantIdAny: "assistant-1,assistant-2,assistant-3",
    customerNumberAny: "+1234567890,+0987654321"
});

⚙️ Parameters

request: Vapi.SessionControllerSessionsExportRequest

requestOptions: SessionsClient.RequestOptions

client.sessions.get({ ...params }) -> Vapi.Session

🔌 Usage

await client.sessions.get({
    id: "id"
});

⚙️ Parameters

request: Vapi.GetSessionsRequest

requestOptions: SessionsClient.RequestOptions

client.sessions.delete({ ...params }) -> Vapi.Session

🔌 Usage

await client.sessions.delete({
    id: "id"
});

⚙️ Parameters

request: Vapi.DeleteSessionsRequest

requestOptions: SessionsClient.RequestOptions

client.sessions.update({ ...params }) -> Vapi.Session

🔌 Usage

await client.sessions.update({
    id: "id"
});

⚙️ Parameters

request: Vapi.UpdateSessionDto

requestOptions: SessionsClient.RequestOptions

PhoneNumbers

client.phoneNumbers.list({ ...params }) -> Vapi.ListPhoneNumbersResponseItem[]

🔌 Usage

await client.phoneNumbers.list();

⚙️ Parameters

request: Vapi.ListPhoneNumbersRequest

requestOptions: PhoneNumbersClient.RequestOptions

client.phoneNumbers.create({ ...params }) -> Vapi.CreatePhoneNumbersResponse

🔌 Usage

await client.phoneNumbers.create({
    provider: "byo-phone-number",
    credentialId: "credentialId"
});

⚙️ Parameters

request: Vapi.CreatePhoneNumbersRequest

requestOptions: PhoneNumbersClient.RequestOptions

client.phoneNumbers.phoneNumberControllerFindAllPaginated({ ...params }) -> Vapi.PhoneNumberPaginatedResponse

🔌 Usage

await client.phoneNumbers.phoneNumberControllerFindAllPaginated();

⚙️ Parameters

request: Vapi.PhoneNumberControllerFindAllPaginatedRequest

requestOptions: PhoneNumbersClient.RequestOptions

client.phoneNumbers.get({ ...params }) -> Vapi.GetPhoneNumbersResponse

🔌 Usage

await client.phoneNumbers.get({
    id: "id"
});

⚙️ Parameters

request: Vapi.GetPhoneNumbersRequest

requestOptions: PhoneNumbersClient.RequestOptions

client.phoneNumbers.delete({ ...params }) -> Vapi.DeletePhoneNumbersResponse

🔌 Usage

await client.phoneNumbers.delete({
    id: "id"
});

⚙️ Parameters

request: Vapi.DeletePhoneNumbersRequest

requestOptions: PhoneNumbersClient.RequestOptions

client.phoneNumbers.update({ ...params }) -> Vapi.UpdatePhoneNumbersResponse

🔌 Usage

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

⚙️ Parameters

request: Vapi.UpdatePhoneNumbersRequest

requestOptions: PhoneNumbersClient.RequestOptions

Tools

client.tools.list({ ...params }) -> Vapi.ListToolsResponseItem[]

🔌 Usage

await client.tools.list();

⚙️ Parameters

request: Vapi.ListToolsRequest

requestOptions: ToolsClient.RequestOptions

client.tools.create({ ...params }) -> Vapi.CreateToolsResponse

🔌 Usage

await client.tools.create({
    type: "apiRequest",
    method: "POST",
    url: "url"
});

⚙️ Parameters

request: Vapi.CreateToolsRequest

requestOptions: ToolsClient.RequestOptions

client.tools.get({ ...params }) -> Vapi.GetToolsResponse

🔌 Usage

await client.tools.get({
    id: "id"
});

⚙️ Parameters

request: Vapi.GetToolsRequest

requestOptions: ToolsClient.RequestOptions

client.tools.delete({ ...params }) -> Vapi.DeleteToolsResponse

🔌 Usage

await client.tools.delete({
    id: "id"
});

⚙️ Parameters

request: Vapi.DeleteToolsRequest

requestOptions: ToolsClient.RequestOptions

client.tools.update({ ...params }) -> Vapi.UpdateToolsResponse

🔌 Usage

await client.tools.update({
    id: "id",
    body: {}
});

⚙️ Parameters

request: Vapi.UpdateToolsRequest

requestOptions: ToolsClient.RequestOptions

client.tools.toolControllerTestCodeExecution() -> Vapi.ToolControllerTestCodeExecutionResponse

🔌 Usage

await client.tools.toolControllerTestCodeExecution();

⚙️ Parameters

requestOptions: ToolsClient.RequestOptions

Files

client.files.list() -> Vapi.File_[]

🔌 Usage

await client.files.list();

⚙️ Parameters

requestOptions: FilesClient.RequestOptions

client.files.create({ ...params }) -> Vapi.File_

🔌 Usage

await client.files.create({
    file: fs.createReadStream("/path/to/your/file")
});

⚙️ Parameters

request: Vapi.CreateFileDto

requestOptions: FilesClient.RequestOptions

client.files.get({ ...params }) -> Vapi.File_

🔌 Usage

await client.files.get({
    id: "id"
});

⚙️ Parameters

request: Vapi.GetFilesRequest

requestOptions: FilesClient.RequestOptions

client.files.delete({ ...params }) -> Vapi.File_

🔌 Usage

await client.files.delete({
    id: "id"
});

⚙️ Parameters

request: Vapi.DeleteFilesRequest

requestOptions: FilesClient.RequestOptions

client.files.update({ ...params }) -> Vapi.File_

🔌 Usage

await client.files.update({
    id: "id"
});

⚙️ Parameters

request: Vapi.UpdateFileDto

requestOptions: FilesClient.RequestOptions

StructuredOutputs

client.structuredOutputs.structuredOutputControllerFindAll({ ...params }) -> Vapi.StructuredOutputPaginatedResponse

🔌 Usage

await client.structuredOutputs.structuredOutputControllerFindAll();

⚙️ Parameters

request: Vapi.StructuredOutputControllerFindAllRequest

requestOptions: StructuredOutputsClient.RequestOptions

client.structuredOutputs.structuredOutputControllerCreate({ ...params }) -> Vapi.StructuredOutput

🔌 Usage

await client.structuredOutputs.structuredOutputControllerCreate({
    name: "name",
    schema: {
        type: "string"
    }
});

⚙️ Parameters

request: Vapi.CreateStructuredOutputDto

requestOptions: StructuredOutputsClient.RequestOptions

client.structuredOutputs.structuredOutputControllerFindOne({ ...params }) -> Vapi.StructuredOutput

🔌 Usage

await client.structuredOutputs.structuredOutputControllerFindOne({
    id: "id"
});

⚙️ Parameters

request: Vapi.StructuredOutputControllerFindOneRequest

requestOptions: StructuredOutputsClient.RequestOptions

client.structuredOutputs.structuredOutputControllerRemove({ ...params }) -> Vapi.StructuredOutput

🔌 Usage

await client.structuredOutputs.structuredOutputControllerRemove({
    id: "id"
});

⚙️ Parameters

request: Vapi.StructuredOutputControllerRemoveRequest

requestOptions: StructuredOutputsClient.RequestOptions

client.structuredOutputs.structuredOutputControllerUpdate({ ...params }) -> Vapi.StructuredOutput

🔌 Usage

await client.structuredOutputs.structuredOutputControllerUpdate({
    id: "id",
    schemaOverride: "schemaOverride"
});

⚙️ Parameters

request: Vapi.UpdateStructuredOutputDto

requestOptions: StructuredOutputsClient.RequestOptions

client.structuredOutputs.structuredOutputControllerRun({ ...params }) -> Vapi.StructuredOutput

🔌 Usage

await client.structuredOutputs.structuredOutputControllerRun({
    callIds: ["callIds"]
});

⚙️ Parameters

request: Vapi.StructuredOutputRunDto

requestOptions: StructuredOutputsClient.RequestOptions

Insight

client.insight.insightControllerFindAll({ ...params }) -> Vapi.InsightPaginatedResponse

🔌 Usage

await client.insight.insightControllerFindAll();

⚙️ Parameters

request: Vapi.InsightControllerFindAllRequest

requestOptions: InsightClient.RequestOptions

client.insight.insightControllerCreate({ ...params }) -> Vapi.InsightControllerCreateResponse

🔌 Usage

await client.insight.insightControllerCreate({
    type: "bar",
    queries: [{
            type: "vapiql-json",
            table: "call",
            column: "id",
            operation: "count"
        }]
});

⚙️ Parameters

request: Vapi.InsightControllerCreateRequest

requestOptions: InsightClient.RequestOptions

client.insight.insightControllerFindOne({ ...params }) -> Vapi.InsightControllerFindOneResponse

🔌 Usage

await client.insight.insightControllerFindOne({
    id: "id"
});

⚙️ Parameters

request: Vapi.InsightControllerFindOneRequest

requestOptions: InsightClient.RequestOptions

client.insight.insightControllerRemove({ ...params }) -> Vapi.InsightControllerRemoveResponse

🔌 Usage

await client.insight.insightControllerRemove({
    id: "id"
});

⚙️ Parameters

request: Vapi.InsightControllerRemoveRequest

requestOptions: InsightClient.RequestOptions

client.insight.insightControllerUpdate({ ...params }) -> Vapi.InsightControllerUpdateResponse

🔌 Usage

await client.insight.insightControllerUpdate({
    id: "id",
    body: {
        type: "bar"
    }
});

⚙️ Parameters

request: Vapi.InsightControllerUpdateRequest

requestOptions: InsightClient.RequestOptions

client.insight.insightControllerRun({ ...params }) -> Vapi.InsightRunResponse

🔌 Usage

await client.insight.insightControllerRun({
    id: "id"
});

⚙️ Parameters

request: Vapi.InsightRunDto

requestOptions: InsightClient.RequestOptions

client.insight.insightControllerPreview({ ...params }) -> Vapi.InsightRunResponse

🔌 Usage

await client.insight.insightControllerPreview({
    type: "bar",
    queries: [{
            type: "vapiql-json",
            table: "call",
            column: "id",
            operation: "count"
        }]
});

⚙️ Parameters

request: Vapi.InsightControllerPreviewRequest

requestOptions: InsightClient.RequestOptions

Eval

client.eval.evalControllerGetPaginated({ ...params }) -> Vapi.EvalPaginatedResponse

🔌 Usage

await client.eval.evalControllerGetPaginated();

⚙️ Parameters

request: Vapi.EvalControllerGetPaginatedRequest

requestOptions: EvalClient.RequestOptions

client.eval.evalControllerCreate({ ...params }) -> Vapi.Eval

🔌 Usage

await client.eval.evalControllerCreate({
    messages: [{
            role: "assistant"
        }],
    type: "chat.mockConversation"
});

⚙️ Parameters

request: Vapi.CreateEvalDto

requestOptions: EvalClient.RequestOptions

client.eval.evalControllerGet({ ...params }) -> Vapi.Eval

🔌 Usage

await client.eval.evalControllerGet({
    id: "id"
});

⚙️ Parameters

request: Vapi.EvalControllerGetRequest

requestOptions: EvalClient.RequestOptions

client.eval.evalControllerRemove({ ...params }) -> Vapi.Eval

🔌 Usage

await client.eval.evalControllerRemove({
    id: "id"
});

⚙️ Parameters

request: Vapi.EvalControllerRemoveRequest

requestOptions: EvalClient.RequestOptions

client.eval.evalControllerUpdate({ ...params }) -> Vapi.Eval

🔌 Usage

await client.eval.evalControllerUpdate({
    id: "id"
});

⚙️ Parameters

request: Vapi.UpdateEvalDto

requestOptions: EvalClient.RequestOptions

client.eval.evalControllerGetRun({ ...params }) -> Vapi.EvalRun

🔌 Usage

await client.eval.evalControllerGetRun({
    id: "id"
});

⚙️ Parameters

request: Vapi.EvalControllerGetRunRequest

requestOptions: EvalClient.RequestOptions

client.eval.evalControllerRemoveRun({ ...params }) -> Vapi.EvalRun

🔌 Usage

await client.eval.evalControllerRemoveRun({
    id: "id"
});

⚙️ Parameters

request: Vapi.EvalControllerRemoveRunRequest

requestOptions: EvalClient.RequestOptions

client.eval.evalControllerGetRunsPaginated({ ...params }) -> Vapi.EvalRunPaginatedResponse

🔌 Usage

await client.eval.evalControllerGetRunsPaginated();

⚙️ Parameters

request: Vapi.EvalControllerGetRunsPaginatedRequest

requestOptions: EvalClient.RequestOptions

client.eval.evalControllerRun({ ...params }) -> Record

🔌 Usage

await client.eval.evalControllerRun({
    target: {
        type: "assistant"
    },
    type: "eval"
});

⚙️ Parameters

request: Vapi.CreateEvalRunDto

requestOptions: EvalClient.RequestOptions

ObservabilityScorecard

client.observabilityScorecard.scorecardControllerGet({ ...params }) -> Vapi.Scorecard

🔌 Usage

await client.observabilityScorecard.scorecardControllerGet({
    id: "id"
});

⚙️ Parameters

request: Vapi.ScorecardControllerGetRequest

requestOptions: ObservabilityScorecardClient.RequestOptions

client.observabilityScorecard.scorecardControllerRemove({ ...params }) -> Vapi.Scorecard

🔌 Usage

await client.observabilityScorecard.scorecardControllerRemove({
    id: "id"
});

⚙️ Parameters

request: Vapi.ScorecardControllerRemoveRequest

requestOptions: ObservabilityScorecardClient.RequestOptions

client.observabilityScorecard.scorecardControllerUpdate({ ...params }) -> Vapi.Scorecard

🔌 Usage

await client.observabilityScorecard.scorecardControllerUpdate({
    id: "id"
});

⚙️ Parameters

request: Vapi.UpdateScorecardDto

requestOptions: ObservabilityScorecardClient.RequestOptions

client.observabilityScorecard.scorecardControllerGetPaginated({ ...params }) -> Vapi.ScorecardPaginatedResponse

🔌 Usage

await client.observabilityScorecard.scorecardControllerGetPaginated();

⚙️ Parameters

request: Vapi.ScorecardControllerGetPaginatedRequest

requestOptions: ObservabilityScorecardClient.RequestOptions

client.observabilityScorecard.scorecardControllerCreate({ ...params }) -> Vapi.Scorecard

🔌 Usage

await client.observabilityScorecard.scorecardControllerCreate({
    metrics: [{
            structuredOutputId: "structuredOutputId",
            conditions: [{
                    "key": "value"
                }]
        }]
});

⚙️ Parameters

request: Vapi.CreateScorecardDto

requestOptions: ObservabilityScorecardClient.RequestOptions

ProviderResources

client.providerResources.providerResourceControllerGetProviderResourcesPaginated({ ...params }) -> Vapi.ProviderResourcePaginatedResponse

🔌 Usage

await client.providerResources.providerResourceControllerGetProviderResourcesPaginated({
    provider: "11labs",
    resourceName: "pronunciation-dictionary"
});

⚙️ Parameters

request: Vapi.ProviderResourceControllerGetProviderResourcesPaginatedRequest

requestOptions: ProviderResourcesClient.RequestOptions

client.providerResources.providerResourceControllerCreateProviderResource({ ...params }) -> Vapi.ProviderResource

🔌 Usage

await client.providerResources.providerResourceControllerCreateProviderResource({
    provider: "11labs",
    resourceName: "pronunciation-dictionary"
});

⚙️ Parameters

request: Vapi.ProviderResourceControllerCreateProviderResourceRequest

requestOptions: ProviderResourcesClient.RequestOptions

client.providerResources.providerResourceControllerGetProviderResource({ ...params }) -> Vapi.ProviderResource

🔌 Usage

await client.providerResources.providerResourceControllerGetProviderResource({
    provider: "11labs",
    resourceName: "pronunciation-dictionary",
    id: "id"
});

⚙️ Parameters

request: Vapi.ProviderResourceControllerGetProviderResourceRequest

requestOptions: ProviderResourcesClient.RequestOptions

client.providerResources.providerResourceControllerDeleteProviderResource({ ...params }) -> Vapi.ProviderResource

🔌 Usage

await client.providerResources.providerResourceControllerDeleteProviderResource({
    provider: "11labs",
    resourceName: "pronunciation-dictionary",
    id: "id"
});

⚙️ Parameters

request: Vapi.ProviderResourceControllerDeleteProviderResourceRequest

requestOptions: ProviderResourcesClient.RequestOptions

client.providerResources.providerResourceControllerUpdateProviderResource({ ...params }) -> Vapi.ProviderResource

🔌 Usage

await client.providerResources.providerResourceControllerUpdateProviderResource({
    provider: "11labs",
    resourceName: "pronunciation-dictionary",
    id: "id"
});

⚙️ Parameters

request: Vapi.ProviderResourceControllerUpdateProviderResourceRequest

requestOptions: ProviderResourcesClient.RequestOptions

Analytics

client.analytics.get({ ...params }) -> Vapi.AnalyticsQueryResult[]

🔌 Usage

await client.analytics.get({
    queries: [{
            table: "call",
            name: "name",
            operations: [{
                    operation: "sum",
                    column: "id"
                }]
        }]
});

⚙️ Parameters

request: Vapi.AnalyticsQueryDto

requestOptions: AnalyticsClient.RequestOptions