# Reference
## Assistants
client.assistants.list({ ...params }) -> Vapi.Assistant[]
-
#### 🔌 Usage
-
-
```typescript
await client.assistants.list();
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.ListAssistantsRequest`
-
**requestOptions:** `AssistantsClient.RequestOptions`
client.assistants.create({ ...params }) -> Vapi.Assistant
-
#### 🔌 Usage
-
-
```typescript
await client.assistants.create({});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.CreateAssistantDto`
-
**requestOptions:** `AssistantsClient.RequestOptions`
client.assistants.get({ ...params }) -> Vapi.Assistant
-
#### 🔌 Usage
-
-
```typescript
await client.assistants.get({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.GetAssistantsRequest`
-
**requestOptions:** `AssistantsClient.RequestOptions`
client.assistants.delete({ ...params }) -> Vapi.Assistant
-
#### 🔌 Usage
-
-
```typescript
await client.assistants.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.DeleteAssistantsRequest`
-
**requestOptions:** `AssistantsClient.RequestOptions`
client.assistants.update({ ...params }) -> Vapi.Assistant
-
#### 🔌 Usage
-
-
```typescript
await client.assistants.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.UpdateAssistantDto`
-
**requestOptions:** `AssistantsClient.RequestOptions`
client.squads.list({ ...params }) -> Vapi.Squad[]
-
#### 🔌 Usage
-
-
```typescript
await client.squads.list();
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.ListSquadsRequest`
-
**requestOptions:** `SquadsClient.RequestOptions`
client.squads.create({ ...params }) -> Vapi.Squad
-
#### 🔌 Usage
-
-
```typescript
await client.squads.create({
members: [{}]
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.CreateSquadDto`
-
**requestOptions:** `SquadsClient.RequestOptions`
client.squads.get({ ...params }) -> Vapi.Squad
-
#### 🔌 Usage
-
-
```typescript
await client.squads.get({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.GetSquadsRequest`
-
**requestOptions:** `SquadsClient.RequestOptions`
client.squads.delete({ ...params }) -> Vapi.Squad
-
#### 🔌 Usage
-
-
```typescript
await client.squads.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.DeleteSquadsRequest`
-
**requestOptions:** `SquadsClient.RequestOptions`
client.squads.update({ ...params }) -> Vapi.Squad
-
#### 🔌 Usage
-
-
```typescript
await client.squads.update({
id: "id",
members: [{}]
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.UpdateSquadDto`
-
**requestOptions:** `SquadsClient.RequestOptions`
client.calls.list({ ...params }) -> Vapi.Call[]
-
#### 🔌 Usage
-
-
```typescript
await client.calls.list();
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.ListCallsRequest`
-
**requestOptions:** `CallsClient.RequestOptions`
client.calls.create({ ...params }) -> Vapi.CreateCallsResponse
-
#### 🔌 Usage
-
-
```typescript
await client.calls.create();
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.CreateCallDto`
-
**requestOptions:** `CallsClient.RequestOptions`
client.calls.callControllerFindAllPaginated({ ...params }) -> Vapi.CallPaginatedResponse
-
#### 🔌 Usage
-
-
```typescript
await client.calls.callControllerFindAllPaginated();
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.CallControllerFindAllPaginatedRequest`
-
**requestOptions:** `CallsClient.RequestOptions`
client.calls.get({ ...params }) -> Vapi.Call
-
#### 🔌 Usage
-
-
```typescript
await client.calls.get({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.GetCallsRequest`
-
**requestOptions:** `CallsClient.RequestOptions`
client.calls.delete({ ...params }) -> Vapi.Call
-
#### 🔌 Usage
-
-
```typescript
await client.calls.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.DeleteCallDto`
-
**requestOptions:** `CallsClient.RequestOptions`
client.calls.update({ ...params }) -> Vapi.Call
-
#### 🔌 Usage
-
-
```typescript
await client.calls.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.UpdateCallDto`
-
**requestOptions:** `CallsClient.RequestOptions`
client.chats.list({ ...params }) -> Vapi.ChatPaginatedResponse
-
#### 🔌 Usage
-
-
```typescript
await client.chats.list();
```
#### ⚙️ 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
-
-
```typescript
await client.chats.create({
input: "input"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.CreateChatDto`
-
**requestOptions:** `ChatsClient.RequestOptions`
client.chats.get({ ...params }) -> Vapi.Chat
-
#### 🔌 Usage
-
-
```typescript
await client.chats.get({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.GetChatsRequest`
-
**requestOptions:** `ChatsClient.RequestOptions`
client.chats.delete({ ...params }) -> Vapi.Chat
-
#### 🔌 Usage
-
-
```typescript
await client.chats.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.DeleteChatsRequest`
-
**requestOptions:** `ChatsClient.RequestOptions`
client.chats.createResponse({ ...params }) -> Vapi.CreateResponseChatsResponse
-
#### 🔌 Usage
-
-
```typescript
await client.chats.createResponse({
input: "input"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.OpenAiResponsesRequest`
-
**requestOptions:** `ChatsClient.RequestOptions`
client.campaigns.campaignControllerFindAll({ ...params }) -> Vapi.CampaignPaginatedResponse
-
#### 🔌 Usage
-
-
```typescript
await client.campaigns.campaignControllerFindAll();
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.CampaignControllerFindAllRequest`
-
**requestOptions:** `CampaignsClient.RequestOptions`
client.campaigns.campaignControllerCreate({ ...params }) -> Vapi.Campaign
-
#### 🔌 Usage
-
-
```typescript
await client.campaigns.campaignControllerCreate({
name: "Q2 Sales Campaign",
phoneNumberId: "phoneNumberId",
customers: [{}]
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.CreateCampaignDto`
-
**requestOptions:** `CampaignsClient.RequestOptions`
client.campaigns.campaignControllerFindOne({ ...params }) -> Vapi.Campaign
-
#### 🔌 Usage
-
-
```typescript
await client.campaigns.campaignControllerFindOne({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.CampaignControllerFindOneRequest`
-
**requestOptions:** `CampaignsClient.RequestOptions`
client.campaigns.campaignControllerRemove({ ...params }) -> Vapi.Campaign
-
#### 🔌 Usage
-
-
```typescript
await client.campaigns.campaignControllerRemove({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.CampaignControllerRemoveRequest`
-
**requestOptions:** `CampaignsClient.RequestOptions`
client.campaigns.campaignControllerUpdate({ ...params }) -> Vapi.Campaign
-
#### 🔌 Usage
-
-
```typescript
await client.campaigns.campaignControllerUpdate({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.UpdateCampaignDto`
-
**requestOptions:** `CampaignsClient.RequestOptions`
client.sessions.list({ ...params }) -> Vapi.SessionPaginatedResponse
-
#### 🔌 Usage
-
-
```typescript
await client.sessions.list();
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.ListSessionsRequest`
-
**requestOptions:** `SessionsClient.RequestOptions`
client.sessions.create({ ...params }) -> Vapi.Session
-
#### 🔌 Usage
-
-
```typescript
await client.sessions.create();
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.CreateSessionDto`
-
**requestOptions:** `SessionsClient.RequestOptions`
client.sessions.get({ ...params }) -> Vapi.Session
-
#### 🔌 Usage
-
-
```typescript
await client.sessions.get({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.GetSessionsRequest`
-
**requestOptions:** `SessionsClient.RequestOptions`
client.sessions.delete({ ...params }) -> Vapi.Session
-
#### 🔌 Usage
-
-
```typescript
await client.sessions.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.DeleteSessionsRequest`
-
**requestOptions:** `SessionsClient.RequestOptions`
client.sessions.update({ ...params }) -> Vapi.Session
-
#### 🔌 Usage
-
-
```typescript
await client.sessions.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.UpdateSessionDto`
-
**requestOptions:** `SessionsClient.RequestOptions`
client.phoneNumbers.list({ ...params }) -> Vapi.ListPhoneNumbersResponseItem[]
-
#### 🔌 Usage
-
-
```typescript
await client.phoneNumbers.list();
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.ListPhoneNumbersRequest`
-
**requestOptions:** `PhoneNumbersClient.RequestOptions`
client.phoneNumbers.create({ ...params }) -> Vapi.CreatePhoneNumbersResponse
-
#### 🔌 Usage
-
-
```typescript
await client.phoneNumbers.create({
provider: "byo-phone-number",
credentialId: "credentialId"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.CreatePhoneNumbersRequest`
-
**requestOptions:** `PhoneNumbersClient.RequestOptions`
client.phoneNumbers.phoneNumberControllerFindAllPaginated({ ...params }) -> Vapi.PhoneNumberPaginatedResponse
-
#### 🔌 Usage
-
-
```typescript
await client.phoneNumbers.phoneNumberControllerFindAllPaginated();
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.PhoneNumberControllerFindAllPaginatedRequest`
-
**requestOptions:** `PhoneNumbersClient.RequestOptions`
client.phoneNumbers.get({ ...params }) -> Vapi.GetPhoneNumbersResponse
-
#### 🔌 Usage
-
-
```typescript
await client.phoneNumbers.get({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.GetPhoneNumbersRequest`
-
**requestOptions:** `PhoneNumbersClient.RequestOptions`
client.phoneNumbers.delete({ ...params }) -> Vapi.DeletePhoneNumbersResponse
-
#### 🔌 Usage
-
-
```typescript
await client.phoneNumbers.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.DeletePhoneNumbersRequest`
-
**requestOptions:** `PhoneNumbersClient.RequestOptions`
client.phoneNumbers.update({ ...params }) -> Vapi.UpdatePhoneNumbersResponse
-
#### 🔌 Usage
-
-
```typescript
await client.phoneNumbers.update({
id: "id",
body: {}
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.UpdatePhoneNumbersRequest`
-
**requestOptions:** `PhoneNumbersClient.RequestOptions`
client.tools.list({ ...params }) -> Vapi.ListToolsResponseItem[]
-
#### 🔌 Usage
-
-
```typescript
await client.tools.list();
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.ListToolsRequest`
-
**requestOptions:** `ToolsClient.RequestOptions`
client.tools.create({ ...params }) -> Vapi.CreateToolsResponse
-
#### 🔌 Usage
-
-
```typescript
await client.tools.create({
type: "apiRequest",
method: "POST",
url: "url"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.CreateToolsRequest`
-
**requestOptions:** `ToolsClient.RequestOptions`
client.tools.get({ ...params }) -> Vapi.GetToolsResponse
-
#### 🔌 Usage
-
-
```typescript
await client.tools.get({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.GetToolsRequest`
-
**requestOptions:** `ToolsClient.RequestOptions`
client.tools.delete({ ...params }) -> Vapi.DeleteToolsResponse
-
#### 🔌 Usage
-
-
```typescript
await client.tools.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.DeleteToolsRequest`
-
**requestOptions:** `ToolsClient.RequestOptions`
client.tools.update({ ...params }) -> Vapi.UpdateToolsResponse
-
#### 🔌 Usage
-
-
```typescript
await client.tools.update({
id: "id",
body: {}
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.UpdateToolsRequest`
-
**requestOptions:** `ToolsClient.RequestOptions`
client.files.list() -> Vapi.File_[]
-
#### 🔌 Usage
-
-
```typescript
await client.files.list();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `FilesClient.RequestOptions`
client.files.create({ ...params }) -> Vapi.File_
-
#### 🔌 Usage
-
-
```typescript
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
-
-
```typescript
await client.files.get({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.GetFilesRequest`
-
**requestOptions:** `FilesClient.RequestOptions`
client.files.delete({ ...params }) -> Vapi.File_
-
#### 🔌 Usage
-
-
```typescript
await client.files.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.DeleteFilesRequest`
-
**requestOptions:** `FilesClient.RequestOptions`
client.files.update({ ...params }) -> Vapi.File_
-
#### 🔌 Usage
-
-
```typescript
await client.files.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.UpdateFileDto`
-
**requestOptions:** `FilesClient.RequestOptions`
client.structuredOutputs.structuredOutputControllerFindAll({ ...params }) -> Vapi.StructuredOutputPaginatedResponse
-
#### 🔌 Usage
-
-
```typescript
await client.structuredOutputs.structuredOutputControllerFindAll();
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.StructuredOutputControllerFindAllRequest`
-
**requestOptions:** `StructuredOutputsClient.RequestOptions`
client.structuredOutputs.structuredOutputControllerCreate({ ...params }) -> Vapi.StructuredOutput
-
#### 🔌 Usage
-
-
```typescript
await client.structuredOutputs.structuredOutputControllerCreate({
name: "name",
schema: {
type: "string"
}
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.CreateStructuredOutputDto`
-
**requestOptions:** `StructuredOutputsClient.RequestOptions`
client.structuredOutputs.structuredOutputControllerFindOne({ ...params }) -> Vapi.StructuredOutput
-
#### 🔌 Usage
-
-
```typescript
await client.structuredOutputs.structuredOutputControllerFindOne({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.StructuredOutputControllerFindOneRequest`
-
**requestOptions:** `StructuredOutputsClient.RequestOptions`
client.structuredOutputs.structuredOutputControllerRemove({ ...params }) -> Vapi.StructuredOutput
-
#### 🔌 Usage
-
-
```typescript
await client.structuredOutputs.structuredOutputControllerRemove({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.StructuredOutputControllerRemoveRequest`
-
**requestOptions:** `StructuredOutputsClient.RequestOptions`
client.structuredOutputs.structuredOutputControllerUpdate({ ...params }) -> Vapi.StructuredOutput
-
#### 🔌 Usage
-
-
```typescript
await client.structuredOutputs.structuredOutputControllerUpdate({
id: "id",
schemaOverride: "schemaOverride"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.UpdateStructuredOutputDto`
-
**requestOptions:** `StructuredOutputsClient.RequestOptions`
client.structuredOutputs.structuredOutputControllerRun({ ...params }) -> Vapi.StructuredOutput
-
#### 🔌 Usage
-
-
```typescript
await client.structuredOutputs.structuredOutputControllerRun({
callIds: ["callIds"]
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.StructuredOutputRunDto`
-
**requestOptions:** `StructuredOutputsClient.RequestOptions`
client.structuredOutputs.structuredOutputControllerSuggest({ ...params }) -> Record[]
-
#### 📝 Description
-
-
Analyzes assistant configuration and generates contextual structured output recommendations
#### 🔌 Usage
-
-
```typescript
await client.structuredOutputs.structuredOutputControllerSuggest({
assistantId: "550e8400-e29b-41d4-a716-446655440000"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.GenerateStructuredOutputSuggestionsDto`
-
**requestOptions:** `StructuredOutputsClient.RequestOptions`
client.insight.insightControllerFindAll({ ...params }) -> Vapi.InsightPaginatedResponse
-
#### 🔌 Usage
-
-
```typescript
await client.insight.insightControllerFindAll();
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.InsightControllerFindAllRequest`
-
**requestOptions:** `InsightClient.RequestOptions`
client.insight.insightControllerCreate({ ...params }) -> Vapi.InsightControllerCreateResponse
-
#### 🔌 Usage
-
-
```typescript
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
-
-
```typescript
await client.insight.insightControllerFindOne({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.InsightControllerFindOneRequest`
-
**requestOptions:** `InsightClient.RequestOptions`
client.insight.insightControllerRemove({ ...params }) -> Vapi.InsightControllerRemoveResponse
-
#### 🔌 Usage
-
-
```typescript
await client.insight.insightControllerRemove({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.InsightControllerRemoveRequest`
-
**requestOptions:** `InsightClient.RequestOptions`
client.insight.insightControllerUpdate({ ...params }) -> Vapi.InsightControllerUpdateResponse
-
#### 🔌 Usage
-
-
```typescript
await client.insight.insightControllerUpdate({
id: "id",
body: {
type: "bar"
}
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.InsightControllerUpdateRequest`
-
**requestOptions:** `InsightClient.RequestOptions`
client.insight.insightControllerRun({ ...params }) -> Vapi.InsightRunResponse
-
#### 🔌 Usage
-
-
```typescript
await client.insight.insightControllerRun({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.InsightRunDto`
-
**requestOptions:** `InsightClient.RequestOptions`
client.insight.insightControllerPreview({ ...params }) -> Vapi.InsightRunResponse
-
#### 🔌 Usage
-
-
```typescript
await client.insight.insightControllerPreview({
type: "bar",
queries: [{
type: "vapiql-json",
table: "call",
column: "id",
operation: "count"
}]
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.InsightControllerPreviewRequest`
-
**requestOptions:** `InsightClient.RequestOptions`
client.eval.evalControllerGetPaginated({ ...params }) -> Vapi.EvalPaginatedResponse
-
#### 🔌 Usage
-
-
```typescript
await client.eval.evalControllerGetPaginated();
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.EvalControllerGetPaginatedRequest`
-
**requestOptions:** `EvalClient.RequestOptions`
client.eval.evalControllerCreate({ ...params }) -> Vapi.Eval
-
#### 🔌 Usage
-
-
```typescript
await client.eval.evalControllerCreate({
messages: [{
role: "assistant"
}],
type: "chat.mockConversation"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.CreateEvalDto`
-
**requestOptions:** `EvalClient.RequestOptions`
client.eval.evalControllerGet({ ...params }) -> Vapi.Eval
-
#### 🔌 Usage
-
-
```typescript
await client.eval.evalControllerGet({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.EvalControllerGetRequest`
-
**requestOptions:** `EvalClient.RequestOptions`
client.eval.evalControllerRemove({ ...params }) -> Vapi.Eval
-
#### 🔌 Usage
-
-
```typescript
await client.eval.evalControllerRemove({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.EvalControllerRemoveRequest`
-
**requestOptions:** `EvalClient.RequestOptions`
client.eval.evalControllerUpdate({ ...params }) -> Vapi.Eval
-
#### 🔌 Usage
-
-
```typescript
await client.eval.evalControllerUpdate({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.UpdateEvalDto`
-
**requestOptions:** `EvalClient.RequestOptions`
client.eval.evalControllerGetRun({ ...params }) -> Vapi.EvalRun
-
#### 🔌 Usage
-
-
```typescript
await client.eval.evalControllerGetRun({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.EvalControllerGetRunRequest`
-
**requestOptions:** `EvalClient.RequestOptions`
client.eval.evalControllerRemoveRun({ ...params }) -> Vapi.EvalRun
-
#### 🔌 Usage
-
-
```typescript
await client.eval.evalControllerRemoveRun({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.EvalControllerRemoveRunRequest`
-
**requestOptions:** `EvalClient.RequestOptions`
client.eval.evalControllerGetRunsPaginated({ ...params }) -> Vapi.EvalRunPaginatedResponse
-
#### 🔌 Usage
-
-
```typescript
await client.eval.evalControllerGetRunsPaginated();
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.EvalControllerGetRunsPaginatedRequest`
-
**requestOptions:** `EvalClient.RequestOptions`
client.eval.evalControllerRun({ ...params }) -> Record
-
#### 🔌 Usage
-
-
```typescript
await client.eval.evalControllerRun({
target: {
type: "assistant"
},
type: "eval"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.CreateEvalRunDto`
-
**requestOptions:** `EvalClient.RequestOptions`
client.observabilityScorecard.scorecardControllerGet({ ...params }) -> Vapi.Scorecard
-
#### 🔌 Usage
-
-
```typescript
await client.observabilityScorecard.scorecardControllerGet({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.ScorecardControllerGetRequest`
-
**requestOptions:** `ObservabilityScorecardClient.RequestOptions`
client.observabilityScorecard.scorecardControllerRemove({ ...params }) -> Vapi.Scorecard
-
#### 🔌 Usage
-
-
```typescript
await client.observabilityScorecard.scorecardControllerRemove({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.ScorecardControllerRemoveRequest`
-
**requestOptions:** `ObservabilityScorecardClient.RequestOptions`
client.observabilityScorecard.scorecardControllerUpdate({ ...params }) -> Vapi.Scorecard
-
#### 🔌 Usage
-
-
```typescript
await client.observabilityScorecard.scorecardControllerUpdate({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.UpdateScorecardDto`
-
**requestOptions:** `ObservabilityScorecardClient.RequestOptions`
client.observabilityScorecard.scorecardControllerGetPaginated({ ...params }) -> Vapi.ScorecardPaginatedResponse
-
#### 🔌 Usage
-
-
```typescript
await client.observabilityScorecard.scorecardControllerGetPaginated();
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.ScorecardControllerGetPaginatedRequest`
-
**requestOptions:** `ObservabilityScorecardClient.RequestOptions`
client.observabilityScorecard.scorecardControllerCreate({ ...params }) -> Vapi.Scorecard
-
#### 🔌 Usage
-
-
```typescript
await client.observabilityScorecard.scorecardControllerCreate({
metrics: [{
structuredOutputId: "structuredOutputId",
conditions: [{
"key": "value"
}]
}]
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.CreateScorecardDto`
-
**requestOptions:** `ObservabilityScorecardClient.RequestOptions`
client.providerResources.providerResourceControllerGetProviderResourcesPaginated({ ...params }) -> Vapi.ProviderResourcePaginatedResponse
-
#### 🔌 Usage
-
-
```typescript
await client.providerResources.providerResourceControllerGetProviderResourcesPaginated({
provider: "11labs",
resourceName: "pronunciation-dictionary"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.ProviderResourceControllerGetProviderResourcesPaginatedRequest`
-
**requestOptions:** `ProviderResourcesClient.RequestOptions`
client.providerResources.providerResourceControllerCreateProviderResource({ ...params }) -> Vapi.ProviderResource
-
#### 🔌 Usage
-
-
```typescript
await client.providerResources.providerResourceControllerCreateProviderResource({
provider: "11labs",
resourceName: "pronunciation-dictionary"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.ProviderResourceControllerCreateProviderResourceRequest`
-
**requestOptions:** `ProviderResourcesClient.RequestOptions`
client.providerResources.providerResourceControllerGetProviderResource({ ...params }) -> Vapi.ProviderResource
-
#### 🔌 Usage
-
-
```typescript
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
-
-
```typescript
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
-
-
```typescript
await client.providerResources.providerResourceControllerUpdateProviderResource({
provider: "11labs",
resourceName: "pronunciation-dictionary",
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.ProviderResourceControllerUpdateProviderResourceRequest`
-
**requestOptions:** `ProviderResourcesClient.RequestOptions`
client.analytics.get({ ...params }) -> Vapi.AnalyticsQueryResult[]
-
#### 🔌 Usage
-
-
```typescript
await client.analytics.get({
queries: [{
table: "call",
name: "name",
operations: [{
operation: "sum",
column: "id"
}]
}]
});
```
#### ⚙️ Parameters
-
-
**request:** `Vapi.AnalyticsQueryDto`
-
**requestOptions:** `AnalyticsClient.RequestOptions`