Skip to content

integrations/dist/voice/deepgram

Interfaces

DeepgramSpeechClient

Methods

synthesizeSpeech()
synthesizeSpeech(input): Promise<DeepgramTextToSpeechResult>;
Parameters
Parameter Type
input DeepgramTextToSpeechInput
Returns

Promise\<DeepgramTextToSpeechResult>

transcribeAudio()
transcribeAudio(input): Promise<DeepgramTranscriptionResult>;
Parameters
Parameter Type
input DeepgramTranscribeAudioInput
Returns

Promise\<DeepgramTranscriptionResult>


DeepgramSpeechClientOptions

Properties

apiBaseUrl?
optional apiBaseUrl?: string;
apiKey
apiKey: string;
fetch?
optional fetch?: {
  (input, init?): Promise<Response>;
  (input, init?): Promise<Response>;
};
Call Signature
(input, init?): Promise<Response>;

MDN Reference

Parameters
Parameter Type
input URL | RequestInfo
init? RequestInit
Returns

Promise\<Response>

Call Signature
(input, init?): Promise<Response>;

MDN Reference

Parameters
Parameter Type
input string | Request | URL
init? RequestInit
Returns

Promise\<Response>


DeepgramSpeechCredentialStatusInput

Properties

apiKey?
optional apiKey?: string;

DeepgramSpeechFullApiGeneratedClient

Extends

  • DeepgramSpeechFullApiSubpackageAgentSubpackageAgentV1SubpackageAgentV1SettingsSubpackageAgentV1SettingsThinkSubpackageAgentV1SettingsThinkModelsGeneratedClient.DeepgramSpeechFullApiSubpackageAuthSubpackageAuthV1SubpackageAuthV1TokensGeneratedClient.DeepgramSpeechFullApiSubpackageListenSubpackageListenV1SubpackageListenV1MediaGeneratedClient.DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ModelsGeneratedClient.DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsGeneratedClient.DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsBillingSubpackageManageV1ProjectsBillingBalancesGeneratedClient.DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsBillingSubpackageManageV1ProjectsBillingBreakdownGeneratedClient.DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsBillingSubpackageManageV1ProjectsBillingFieldsGeneratedClient.DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsBillingSubpackageManageV1ProjectsBillingPurchasesGeneratedClient.DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsKeysGeneratedClient.DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsMembersGeneratedClient.DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsMembersSubpackageManageV1ProjectsMembersInvitesGeneratedClient.DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsMembersSubpackageManageV1ProjectsMembersScopesGeneratedClient.DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsModelsGeneratedClient.DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsRequestsGeneratedClient.DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsUsageGeneratedClient.DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsUsageSubpackageManageV1ProjectsUsageBreakdownGeneratedClient.DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsUsageSubpackageManageV1ProjectsUsageFieldsGeneratedClient.DeepgramSpeechFullApiSubpackageReadSubpackageReadV1SubpackageReadV1TextGeneratedClient.DeepgramSpeechFullApiSubpackageSelfHostedSubpackageSelfHostedV1SubpackageSelfHostedV1DistributionCredentialsGeneratedClient.DeepgramSpeechFullApiSubpackageSpeakSubpackageSpeakV1SubpackageSpeakV1AudioGeneratedClient.DeepgramSpeechFullApiSubpackageVoiceAgentSubpackageVoiceAgentConfigurationsGeneratedClient.DeepgramSpeechFullApiSubpackageVoiceAgentSubpackageVoiceAgentVariablesGeneratedClient

Methods

Analyze()
Analyze(...args): Promise<DeepgramSpeechFullApiSchemaReadV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"POST /v1/read">]
Returns

Promise\<DeepgramSpeechFullApiSchemaReadV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageReadSubpackageReadV1SubpackageReadV1TextGeneratedClient.Analyze
Create()
Create(...args): Promise<DeepgramSpeechFullApiSchemaCreateAgentConfigurationV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"POST /v1/projects/{project_id}/agents">]
Returns

Promise\<DeepgramSpeechFullApiSchemaCreateAgentConfigurationV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageVoiceAgentSubpackageVoiceAgentConfigurationsGeneratedClient.Create
Create2()
Create2(...args): Promise<DeepgramSpeechFullApiSchemaAgentVariableV1>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"POST /v1/projects/{project_id}/agent-variables">]
Returns

Promise\<DeepgramSpeechFullApiSchemaAgentVariableV1>

Inherited from
DeepgramSpeechFullApiSubpackageVoiceAgentSubpackageVoiceAgentVariablesGeneratedClient.Create2
Create3()
Create3(...args): Promise<DeepgramSpeechFullApiSchemaCreateKeyV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"POST /v1/projects/{project_id}/keys">]
Returns

Promise\<DeepgramSpeechFullApiSchemaCreateKeyV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsKeysGeneratedClient.Create3
Create4()
Create4(...args): Promise<DeepgramSpeechFullApiSchemaCreateProjectInviteV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"POST /v1/projects/{project_id}/invites">]
Returns

Promise\<DeepgramSpeechFullApiSchemaCreateProjectInviteV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsMembersSubpackageManageV1ProjectsMembersInvitesGeneratedClient.Create4
Create5()
Create5(...args): Promise<DeepgramSpeechFullApiSchemaCreateProjectDistributionCredentialsV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"POST /v1/projects/{project_id}/self-hosted/distribution/credentials">]
Returns

Promise\<DeepgramSpeechFullApiSchemaCreateProjectDistributionCredentialsV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageSelfHostedSubpackageSelfHostedV1SubpackageSelfHostedV1DistributionCredentialsGeneratedClient.Create5
Delete()
Delete(...args): Promise<DeepgramSpeechFullApiSchemaDeleteAgentConfigurationV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"DELETE /v1/projects/{project_id}/agents/{agent_id}">]
Returns

Promise\<DeepgramSpeechFullApiSchemaDeleteAgentConfigurationV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageVoiceAgentSubpackageVoiceAgentConfigurationsGeneratedClient.Delete
Delete2()
Delete2(...args): Promise<DeepgramSpeechFullApiSchemaDeleteAgentVariableV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"DELETE /v1/projects/{project_id}/agent-variables/{variable_id}">]
Returns

Promise\<DeepgramSpeechFullApiSchemaDeleteAgentVariableV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageVoiceAgentSubpackageVoiceAgentVariablesGeneratedClient.Delete2
Delete3()
Delete3(...args): Promise<DeepgramSpeechFullApiSchemaDeleteProjectV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"DELETE /v1/projects/{project_id}">]
Returns

Promise\<DeepgramSpeechFullApiSchemaDeleteProjectV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsGeneratedClient.Delete3
Delete4()
Delete4(...args): Promise<DeepgramSpeechFullApiSchemaDeleteProjectKeyV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"DELETE /v1/projects/{project_id}/keys/{key_id}">]
Returns

Promise\<DeepgramSpeechFullApiSchemaDeleteProjectKeyV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsKeysGeneratedClient.Delete4
Delete5()
Delete5(...args): Promise<DeepgramSpeechFullApiSchemaDeleteProjectMemberV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"DELETE /v1/projects/{project_id}/members/{member_id}">]
Returns

Promise\<DeepgramSpeechFullApiSchemaDeleteProjectMemberV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsMembersGeneratedClient.Delete5
Delete6()
Delete6(...args): Promise<DeepgramSpeechFullApiSchemaDeleteProjectInviteV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"DELETE /v1/projects/{project_id}/invites/{email}">]
Returns

Promise\<DeepgramSpeechFullApiSchemaDeleteProjectInviteV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsMembersSubpackageManageV1ProjectsMembersInvitesGeneratedClient.Delete6
Delete7()
Delete7(...args): Promise<DeepgramSpeechFullApiSchemaGetProjectDistributionCredentialsV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"DELETE /v1/projects/{project_id}/self-hosted/distribution/credentials/{distribution_credentials_id}">]
Returns

Promise\<DeepgramSpeechFullApiSchemaGetProjectDistributionCredentialsV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageSelfHostedSubpackageSelfHostedV1SubpackageSelfHostedV1DistributionCredentialsGeneratedClient.Delete7
Generate()
Generate(...args): Promise<DeepgramSpeechFullApiSchemaSpeakV1AudioGenerateResponse200>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"POST /v1/speak">]
Returns

Promise\<DeepgramSpeechFullApiSchemaSpeakV1AudioGenerateResponse200>

Inherited from
DeepgramSpeechFullApiSubpackageSpeakSubpackageSpeakV1SubpackageSpeakV1AudioGeneratedClient.Generate
Get()
Get(...args): Promise<DeepgramSpeechFullApiSchemaAgentConfigurationV1>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"GET /v1/projects/{project_id}/agents/{agent_id}">]
Returns

Promise\<DeepgramSpeechFullApiSchemaAgentConfigurationV1>

Inherited from
DeepgramSpeechFullApiSubpackageVoiceAgentSubpackageVoiceAgentConfigurationsGeneratedClient.Get
Get10()
Get10(...args): Promise<DeepgramSpeechFullApiSchemaGetProjectBalanceV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"GET /v1/projects/{project_id}/balances/{balance_id}">]
Returns

Promise\<DeepgramSpeechFullApiSchemaGetProjectBalanceV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsBillingSubpackageManageV1ProjectsBillingBalancesGeneratedClient.Get10
Get11()
Get11(...args): Promise<DeepgramSpeechFullApiSchemaGetProjectDistributionCredentialsV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"GET /v1/projects/{project_id}/self-hosted/distribution/credentials/{distribution_credentials_id}">]
Returns

Promise\<DeepgramSpeechFullApiSchemaGetProjectDistributionCredentialsV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageSelfHostedSubpackageSelfHostedV1SubpackageSelfHostedV1DistributionCredentialsGeneratedClient.Get11
Get2()
Get2(...args): Promise<DeepgramSpeechFullApiSchemaAgentVariableV1>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"GET /v1/projects/{project_id}/agent-variables/{variable_id}">]
Returns

Promise\<DeepgramSpeechFullApiSchemaAgentVariableV1>

Inherited from
DeepgramSpeechFullApiSubpackageVoiceAgentSubpackageVoiceAgentVariablesGeneratedClient.Get2
Get3()
Get3(...args): Promise<DeepgramSpeechFullApiSchemaGetProjectV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"GET /v1/projects/{project_id}">]
Returns

Promise\<DeepgramSpeechFullApiSchemaGetProjectV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsGeneratedClient.Get3
Get4()
Get4(...args): Promise<DeepgramSpeechFullApiSchemaGetModelV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"GET /v1/projects/{project_id}/models/{model_id}">]
Returns

Promise\<DeepgramSpeechFullApiSchemaGetModelV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsModelsGeneratedClient.Get4
Get5()
Get5(...args): Promise<DeepgramSpeechFullApiSchemaGetModelV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"GET /v1/models/{model_id}">]
Returns

Promise\<DeepgramSpeechFullApiSchemaGetModelV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ModelsGeneratedClient.Get5
Get6()
Get6(...args): Promise<DeepgramSpeechFullApiSchemaGetProjectKeyV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"GET /v1/projects/{project_id}/keys/{key_id}">]
Returns

Promise\<DeepgramSpeechFullApiSchemaGetProjectKeyV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsKeysGeneratedClient.Get6
Get7()
Get7(...args): Promise<DeepgramSpeechFullApiSchemaGetProjectRequestV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"GET /v1/projects/{project_id}/requests/{request_id}">]
Returns

Promise\<DeepgramSpeechFullApiSchemaGetProjectRequestV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsRequestsGeneratedClient.Get7
Get8()
Get8(...args): Promise<DeepgramSpeechFullApiSchemaUsageV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"GET /v1/projects/{project_id}/usage">]
Returns

Promise\<DeepgramSpeechFullApiSchemaUsageV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsUsageGeneratedClient.Get8
Get9()
Get9(...args): Promise<DeepgramSpeechFullApiSchemaUsageBreakdownV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"GET /v1/projects/{project_id}/usage/breakdown">]
Returns

Promise\<DeepgramSpeechFullApiSchemaUsageBreakdownV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsUsageSubpackageManageV1ProjectsUsageBreakdownGeneratedClient.Get9
Grant()
Grant(...args): Promise<DeepgramSpeechFullApiSchemaGrantV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"POST /v1/auth/grant">]
Returns

Promise\<DeepgramSpeechFullApiSchemaGrantV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageAuthSubpackageAuthV1SubpackageAuthV1TokensGeneratedClient.Grant
Leave()
Leave(...args): Promise<DeepgramSpeechFullApiSchemaLeaveProjectV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"DELETE /v1/projects/{project_id}/leave">]
Returns

Promise\<DeepgramSpeechFullApiSchemaLeaveProjectV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsGeneratedClient.Leave
List()
List(...args): Promise<DeepgramSpeechFullApiSchemaAgentThinkModelsV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"GET /v1/agent/settings/think/models">]
Returns

Promise\<DeepgramSpeechFullApiSchemaAgentThinkModelsV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageAgentSubpackageAgentV1SubpackageAgentV1SettingsSubpackageAgentV1SettingsThinkSubpackageAgentV1SettingsThinkModelsGeneratedClient.List
List10()
List10(...args): Promise<DeepgramSpeechFullApiSchemaListProjectInvitesV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"GET /v1/projects/{project_id}/invites">]
Returns

Promise\<DeepgramSpeechFullApiSchemaListProjectInvitesV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsMembersSubpackageManageV1ProjectsMembersInvitesGeneratedClient.List10
List11()
List11(...args): Promise<DeepgramSpeechFullApiSchemaListProjectRequestsV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"GET /v1/projects/{project_id}/requests">]
Returns

Promise\<DeepgramSpeechFullApiSchemaListProjectRequestsV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsRequestsGeneratedClient.List11
List12()
List12(...args): Promise<DeepgramSpeechFullApiSchemaUsageFieldsV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"GET /v1/projects/{project_id}/usage/fields">]
Returns

Promise\<DeepgramSpeechFullApiSchemaUsageFieldsV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsUsageSubpackageManageV1ProjectsUsageFieldsGeneratedClient.List12
List13()
List13(...args): Promise<DeepgramSpeechFullApiSchemaListProjectBalancesV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"GET /v1/projects/{project_id}/balances">]
Returns

Promise\<DeepgramSpeechFullApiSchemaListProjectBalancesV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsBillingSubpackageManageV1ProjectsBillingBalancesGeneratedClient.List13
List14()
List14(...args): Promise<DeepgramSpeechFullApiSchemaBillingBreakdownV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"GET /v1/projects/{project_id}/billing/breakdown">]
Returns

Promise\<DeepgramSpeechFullApiSchemaBillingBreakdownV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsBillingSubpackageManageV1ProjectsBillingBreakdownGeneratedClient.List14
List15()
List15(...args): Promise<DeepgramSpeechFullApiSchemaListBillingFieldsV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"GET /v1/projects/{project_id}/billing/fields">]
Returns

Promise\<DeepgramSpeechFullApiSchemaListBillingFieldsV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsBillingSubpackageManageV1ProjectsBillingFieldsGeneratedClient.List15
List16()
List16(...args): Promise<DeepgramSpeechFullApiSchemaListProjectPurchasesV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"GET /v1/projects/{project_id}/purchases">]
Returns

Promise\<DeepgramSpeechFullApiSchemaListProjectPurchasesV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsBillingSubpackageManageV1ProjectsBillingPurchasesGeneratedClient.List16
List17()
List17(...args): Promise<DeepgramSpeechFullApiSchemaListProjectDistributionCredentialsV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"GET /v1/projects/{project_id}/self-hosted/distribution/credentials">]
Returns

Promise\<DeepgramSpeechFullApiSchemaListProjectDistributionCredentialsV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageSelfHostedSubpackageSelfHostedV1SubpackageSelfHostedV1DistributionCredentialsGeneratedClient.List17
List2()
List2(...args): Promise<DeepgramSpeechFullApiSchemaListAgentConfigurationsV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"GET /v1/projects/{project_id}/agents">]
Returns

Promise\<DeepgramSpeechFullApiSchemaListAgentConfigurationsV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageVoiceAgentSubpackageVoiceAgentConfigurationsGeneratedClient.List2
List3()
List3(...args): Promise<DeepgramSpeechFullApiSchemaListAgentVariablesV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"GET /v1/projects/{project_id}/agent-variables">]
Returns

Promise\<DeepgramSpeechFullApiSchemaListAgentVariablesV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageVoiceAgentSubpackageVoiceAgentVariablesGeneratedClient.List3
List4()
List4(...args): Promise<DeepgramSpeechFullApiSchemaListProjectsV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"GET /v1/projects">]
Returns

Promise\<DeepgramSpeechFullApiSchemaListProjectsV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsGeneratedClient.List4
List5()
List5(...args): Promise<DeepgramSpeechFullApiSchemaListModelsV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"GET /v1/projects/{project_id}/models">]
Returns

Promise\<DeepgramSpeechFullApiSchemaListModelsV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsModelsGeneratedClient.List5
List6()
List6(...args): Promise<DeepgramSpeechFullApiSchemaListModelsV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"GET /v1/models">]
Returns

Promise\<DeepgramSpeechFullApiSchemaListModelsV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ModelsGeneratedClient.List6
List7()
List7(...args): Promise<DeepgramSpeechFullApiSchemaListProjectKeysV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"GET /v1/projects/{project_id}/keys">]
Returns

Promise\<DeepgramSpeechFullApiSchemaListProjectKeysV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsKeysGeneratedClient.List7
List8()
List8(...args): Promise<DeepgramSpeechFullApiSchemaListProjectMembersV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"GET /v1/projects/{project_id}/members">]
Returns

Promise\<DeepgramSpeechFullApiSchemaListProjectMembersV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsMembersGeneratedClient.List8
List9()
List9(...args): Promise<DeepgramSpeechFullApiSchemaListProjectMemberScopesV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"GET /v1/projects/{project_id}/members/{member_id}/scopes">]
Returns

Promise\<DeepgramSpeechFullApiSchemaListProjectMemberScopesV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsMembersSubpackageManageV1ProjectsMembersScopesGeneratedClient.List9
Transcribe()
Transcribe(...args): Promise<DeepgramSpeechFullApiSchemaListenV1MediaTranscribeResponse200>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"POST /v1/listen">]
Returns

Promise\<DeepgramSpeechFullApiSchemaListenV1MediaTranscribeResponse200>

Inherited from
DeepgramSpeechFullApiSubpackageListenSubpackageListenV1SubpackageListenV1MediaGeneratedClient.Transcribe
Update()
Update(...args): Promise<DeepgramSpeechFullApiSchemaAgentConfigurationV1>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"PUT /v1/projects/{project_id}/agents/{agent_id}">]
Returns

Promise\<DeepgramSpeechFullApiSchemaAgentConfigurationV1>

Inherited from
DeepgramSpeechFullApiSubpackageVoiceAgentSubpackageVoiceAgentConfigurationsGeneratedClient.Update
Update2()
Update2(...args): Promise<DeepgramSpeechFullApiSchemaAgentVariableV1>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"PATCH /v1/projects/{project_id}/agent-variables/{variable_id}">]
Returns

Promise\<DeepgramSpeechFullApiSchemaAgentVariableV1>

Inherited from
DeepgramSpeechFullApiSubpackageVoiceAgentSubpackageVoiceAgentVariablesGeneratedClient.Update2
Update3()
Update3(...args): Promise<DeepgramSpeechFullApiSchemaUpdateProjectV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"PATCH /v1/projects/{project_id}">]
Returns

Promise\<DeepgramSpeechFullApiSchemaUpdateProjectV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsGeneratedClient.Update3
Update4()
Update4(...args): Promise<DeepgramSpeechFullApiSchemaUpdateProjectMemberScopesV1Response>;
Parameters
Parameter Type
...args [DeepgramSpeechFullApiOperationInput\<"PUT /v1/projects/{project_id}/members/{member_id}/scopes">]
Returns

Promise\<DeepgramSpeechFullApiSchemaUpdateProjectMemberScopesV1Response>

Inherited from
DeepgramSpeechFullApiSubpackageManageSubpackageManageV1SubpackageManageV1ProjectsSubpackageManageV1ProjectsMembersSubpackageManageV1ProjectsMembersScopesGeneratedClient.Update4

DeepgramSpeechFullApiOperation

Properties

functionName
functionName: string;
id
id: string;
method
method: DeepgramSpeechFullApiOperationMethod;
operationId
operationId: string;
path
path: string;
requestContentTypes
requestContentTypes: readonly string[];
sourceUrl
sourceUrl: string;
summary
summary: string;
tags
tags: readonly string[];

DeepgramSpeechFullApiOperationQueryMap

Properties

DELETE /v1/projects/{project_id}
DELETE /v1/projects/{project_id}: {
};
DELETE /v1/projects/{project_id}/agent-variables/{variable_id}
DELETE /v1/projects/{project_id}/agent-variables/{variable_id}: {
};
DELETE /v1/projects/{project_id}/agents/{agent_id}
DELETE /v1/projects/{project_id}/agents/{agent_id}: {
};
DELETE /v1/projects/{project_id}/invites/{email}
DELETE /v1/projects/{project_id}/invites/{email}: {
};
DELETE /v1/projects/{project_id}/keys/{key_id}
DELETE /v1/projects/{project_id}/keys/{key_id}: {
};
DELETE /v1/projects/{project_id}/leave
DELETE /v1/projects/{project_id}/leave: {
};
DELETE /v1/projects/{project_id}/members/{member_id}
DELETE /v1/projects/{project_id}/members/{member_id}: {
};
DELETE /v1/projects/{project_id}/self-hosted/distribution/credentials/{distribution_credentials_id}
DELETE /v1/projects/{project_id}/self-hosted/distribution/credentials/{distribution_credentials_id}: {
};
GET /v1/agent/settings/think/models
GET /v1/agent/settings/think/models: {
};
GET /v1/models
GET /v1/models: {
  include_outdated?: boolean;
};
include_outdated?
optional include_outdated?: boolean;
GET /v1/models/{model_id}
GET /v1/models/{model_id}: {
};
GET /v1/projects
GET /v1/projects: {
};
GET /v1/projects/{project_id}
GET /v1/projects/{project_id}: {
  limit?: number;
  page?: number;
};
limit?
optional limit?: number;
page?
optional page?: number;
GET /v1/projects/{project_id}/agent-variables
GET /v1/projects/{project_id}/agent-variables: {
};
GET /v1/projects/{project_id}/agent-variables/{variable_id}
GET /v1/projects/{project_id}/agent-variables/{variable_id}: {
};
GET /v1/projects/{project_id}/agents
GET /v1/projects/{project_id}/agents: {
};
GET /v1/projects/{project_id}/agents/{agent_id}
GET /v1/projects/{project_id}/agents/{agent_id}: {
};
GET /v1/projects/{project_id}/balances
GET /v1/projects/{project_id}/balances: {
};
GET /v1/projects/{project_id}/balances/{balance_id}
GET /v1/projects/{project_id}/balances/{balance_id}: {
};
GET /v1/projects/{project_id}/billing/breakdown
GET /v1/projects/{project_id}/billing/breakdown: {
  accessor?: string;
  deployment?: DeepgramSpeechFullApiSchemaV1ProjectsProjectIdBillingBreakdownGetParametersDeployment;
  end?: string;
  grouping?: readonly DeepgramSpeechFullApiSchemaV1ProjectsProjectIdBillingBreakdownGetParametersGroupingSchemaItems[];
  line_item?: string;
  start?: string;
  tag?: string;
};
accessor?
optional accessor?: string;
deployment?
optional deployment?: DeepgramSpeechFullApiSchemaV1ProjectsProjectIdBillingBreakdownGetParametersDeployment;
end?
optional end?: string;
grouping?
optional grouping?: readonly DeepgramSpeechFullApiSchemaV1ProjectsProjectIdBillingBreakdownGetParametersGroupingSchemaItems[];
line_item?
optional line_item?: string;
start?
optional start?: string;
tag?
optional tag?: string;
GET /v1/projects/{project_id}/billing/fields
GET /v1/projects/{project_id}/billing/fields: {
  end?: string;
  start?: string;
};
end?
optional end?: string;
start?
optional start?: string;
GET /v1/projects/{project_id}/invites
GET /v1/projects/{project_id}/invites: {
};
GET /v1/projects/{project_id}/keys
GET /v1/projects/{project_id}/keys: {
  status?: DeepgramSpeechFullApiSchemaV1ProjectsProjectIdKeysGetParametersStatus;
};
status?
optional status?: DeepgramSpeechFullApiSchemaV1ProjectsProjectIdKeysGetParametersStatus;
GET /v1/projects/{project_id}/keys/{key_id}
GET /v1/projects/{project_id}/keys/{key_id}: {
};
GET /v1/projects/{project_id}/members
GET /v1/projects/{project_id}/members: {
};
GET /v1/projects/{project_id}/members/{member_id}/scopes
GET /v1/projects/{project_id}/members/{member_id}/scopes: {
};
GET /v1/projects/{project_id}/models
GET /v1/projects/{project_id}/models: {
  include_outdated?: boolean;
};
include_outdated?
optional include_outdated?: boolean;
GET /v1/projects/{project_id}/models/{model_id}
GET /v1/projects/{project_id}/models/{model_id}: {
};
GET /v1/projects/{project_id}/purchases
GET /v1/projects/{project_id}/purchases: {
  limit?: number;
};
limit?
optional limit?: number;
GET /v1/projects/{project_id}/requests
GET /v1/projects/{project_id}/requests: {
  accessor?: string;
  deployment?: DeepgramSpeechFullApiSchemaV1ProjectsProjectIdRequestsGetParametersDeployment;
  end?: string;
  endpoint?: DeepgramSpeechFullApiSchemaV1ProjectsProjectIdRequestsGetParametersEndpoint;
  limit?: number;
  method?: DeepgramSpeechFullApiSchemaV1ProjectsProjectIdRequestsGetParametersMethod;
  page?: number;
  request_id?: string;
  start?: string;
  status?: DeepgramSpeechFullApiSchemaV1ProjectsProjectIdRequestsGetParametersStatus;
};
accessor?
optional accessor?: string;
deployment?
optional deployment?: DeepgramSpeechFullApiSchemaV1ProjectsProjectIdRequestsGetParametersDeployment;
end?
optional end?: string;
endpoint?
optional endpoint?: DeepgramSpeechFullApiSchemaV1ProjectsProjectIdRequestsGetParametersEndpoint;
limit?
optional limit?: number;
method?
optional method?: DeepgramSpeechFullApiSchemaV1ProjectsProjectIdRequestsGetParametersMethod;
page?
optional page?: number;
request_id?
optional request_id?: string;
start?
optional start?: string;
status?
optional status?: DeepgramSpeechFullApiSchemaV1ProjectsProjectIdRequestsGetParametersStatus;
GET /v1/projects/{project_id}/requests/{request_id}
GET /v1/projects/{project_id}/requests/{request_id}: {
};
GET /v1/projects/{project_id}/self-hosted/distribution/credentials
GET /v1/projects/{project_id}/self-hosted/distribution/credentials: {
};
GET /v1/projects/{project_id}/self-hosted/distribution/credentials/{distribution_credentials_id}
GET /v1/projects/{project_id}/self-hosted/distribution/credentials/{distribution_credentials_id}: {
};
GET /v1/projects/{project_id}/usage
GET /v1/projects/{project_id}/usage: {
  accessor?: string;
  alternatives?: boolean;
  callback?: boolean;
  callback_method?: boolean;
  channels?: boolean;
  custom_intent?: boolean;
  custom_intent_mode?: boolean;
  custom_topic?: boolean;
  custom_topic_mode?: boolean;
  deployment?: DeepgramSpeechFullApiSchemaV1ProjectsProjectIdUsageGetParametersDeployment;
  detect_entities?: boolean;
  detect_language?: boolean;
  diarize?: boolean;
  dictation?: boolean;
  encoding?: boolean;
  end?: string;
  endpoint?: DeepgramSpeechFullApiSchemaV1ProjectsProjectIdUsageGetParametersEndpoint;
  extra?: boolean;
  filler_words?: boolean;
  intents?: boolean;
  keyterm?: boolean;
  keywords?: boolean;
  language?: boolean;
  measurements?: boolean;
  method?: DeepgramSpeechFullApiSchemaV1ProjectsProjectIdUsageGetParametersMethod;
  model?: string;
  multichannel?: boolean;
  numerals?: boolean;
  paragraphs?: boolean;
  profanity_filter?: boolean;
  punctuate?: boolean;
  redact?: boolean;
  replace?: boolean;
  sample_rate?: boolean;
  search?: boolean;
  sentiment?: boolean;
  smart_format?: boolean;
  start?: string;
  summarize?: boolean;
  tag?: string;
  topics?: boolean;
  utt_split?: boolean;
  utterances?: boolean;
  version?: boolean;
};
accessor?
optional accessor?: string;
alternatives?
optional alternatives?: boolean;
callback?
optional callback?: boolean;
callback_method?
optional callback_method?: boolean;
channels?
optional channels?: boolean;
custom_intent?
optional custom_intent?: boolean;
custom_intent_mode?
optional custom_intent_mode?: boolean;
custom_topic?
optional custom_topic?: boolean;
custom_topic_mode?
optional custom_topic_mode?: boolean;
deployment?
optional deployment?: DeepgramSpeechFullApiSchemaV1ProjectsProjectIdUsageGetParametersDeployment;
detect_entities?
optional detect_entities?: boolean;
detect_language?
optional detect_language?: boolean;
diarize?
optional diarize?: boolean;
dictation?
optional dictation?: boolean;
encoding?
optional encoding?: boolean;
end?
optional end?: string;
endpoint?
optional endpoint?: DeepgramSpeechFullApiSchemaV1ProjectsProjectIdUsageGetParametersEndpoint;
extra?
optional extra?: boolean;
filler_words?
optional filler_words?: boolean;
intents?
optional intents?: boolean;
keyterm?
optional keyterm?: boolean;
keywords?
optional keywords?: boolean;
language?
optional language?: boolean;
measurements?
optional measurements?: boolean;
method?
optional method?: DeepgramSpeechFullApiSchemaV1ProjectsProjectIdUsageGetParametersMethod;
model?
optional model?: string;
multichannel?
optional multichannel?: boolean;
numerals?
optional numerals?: boolean;
paragraphs?
optional paragraphs?: boolean;
profanity_filter?
optional profanity_filter?: boolean;
punctuate?
optional punctuate?: boolean;
redact?
optional redact?: boolean;
replace?
optional replace?: boolean;
sample_rate?
optional sample_rate?: boolean;
optional search?: boolean;
sentiment?
optional sentiment?: boolean;
smart_format?
optional smart_format?: boolean;
start?
optional start?: string;
summarize?
optional summarize?: boolean;
tag?
optional tag?: string;
topics?
optional topics?: boolean;
utt_split?
optional utt_split?: boolean;
utterances?
optional utterances?: boolean;
version?
optional version?: boolean;
GET /v1/projects/{project_id}/usage/breakdown
GET /v1/projects/{project_id}/usage/breakdown: {
  accessor?: string;
  alternatives?: boolean;
  callback?: boolean;
  callback_method?: boolean;
  channels?: boolean;
  custom_intent?: boolean;
  custom_intent_mode?: boolean;
  custom_topic?: boolean;
  custom_topic_mode?: boolean;
  deployment?: DeepgramSpeechFullApiSchemaV1ProjectsProjectIdUsageBreakdownGetParametersDeployment;
  detect_entities?: boolean;
  detect_language?: boolean;
  diarize?: boolean;
  dictation?: boolean;
  encoding?: boolean;
  end?: string;
  endpoint?: DeepgramSpeechFullApiSchemaV1ProjectsProjectIdUsageBreakdownGetParametersEndpoint;
  extra?: boolean;
  filler_words?: boolean;
  grouping?: DeepgramSpeechFullApiSchemaV1ProjectsProjectIdUsageBreakdownGetParametersGrouping;
  intents?: boolean;
  keyterm?: boolean;
  keywords?: boolean;
  language?: boolean;
  measurements?: boolean;
  method?: DeepgramSpeechFullApiSchemaV1ProjectsProjectIdUsageBreakdownGetParametersMethod;
  model?: string;
  multichannel?: boolean;
  numerals?: boolean;
  paragraphs?: boolean;
  profanity_filter?: boolean;
  punctuate?: boolean;
  redact?: boolean;
  replace?: boolean;
  sample_rate?: boolean;
  search?: boolean;
  sentiment?: boolean;
  smart_format?: boolean;
  start?: string;
  summarize?: boolean;
  tag?: string;
  topics?: boolean;
  utt_split?: boolean;
  utterances?: boolean;
  version?: boolean;
};
accessor?
optional accessor?: string;
alternatives?
optional alternatives?: boolean;
callback?
optional callback?: boolean;
callback_method?
optional callback_method?: boolean;
channels?
optional channels?: boolean;
custom_intent?
optional custom_intent?: boolean;
custom_intent_mode?
optional custom_intent_mode?: boolean;
custom_topic?
optional custom_topic?: boolean;
custom_topic_mode?
optional custom_topic_mode?: boolean;
deployment?
optional deployment?: DeepgramSpeechFullApiSchemaV1ProjectsProjectIdUsageBreakdownGetParametersDeployment;
detect_entities?
optional detect_entities?: boolean;
detect_language?
optional detect_language?: boolean;
diarize?
optional diarize?: boolean;
dictation?
optional dictation?: boolean;
encoding?
optional encoding?: boolean;
end?
optional end?: string;
endpoint?
optional endpoint?: DeepgramSpeechFullApiSchemaV1ProjectsProjectIdUsageBreakdownGetParametersEndpoint;
extra?
optional extra?: boolean;
filler_words?
optional filler_words?: boolean;
grouping?
optional grouping?: DeepgramSpeechFullApiSchemaV1ProjectsProjectIdUsageBreakdownGetParametersGrouping;
intents?
optional intents?: boolean;
keyterm?
optional keyterm?: boolean;
keywords?
optional keywords?: boolean;
language?
optional language?: boolean;
measurements?
optional measurements?: boolean;
method?
optional method?: DeepgramSpeechFullApiSchemaV1ProjectsProjectIdUsageBreakdownGetParametersMethod;
model?
optional model?: string;
multichannel?
optional multichannel?: boolean;
numerals?
optional numerals?: boolean;
paragraphs?
optional paragraphs?: boolean;
profanity_filter?
optional profanity_filter?: boolean;
punctuate?
optional punctuate?: boolean;
redact?
optional redact?: boolean;
replace?
optional replace?: boolean;
sample_rate?
optional sample_rate?: boolean;
search?
optional search?: boolean;
sentiment?
optional sentiment?: boolean;
smart_format?
optional smart_format?: boolean;
start?
optional start?: string;
summarize?
optional summarize?: boolean;
tag?
optional tag?: string;
topics?
optional topics?: boolean;
utt_split?
optional utt_split?: boolean;
utterances?
optional utterances?: boolean;
version?
optional version?: boolean;
GET /v1/projects/{project_id}/usage/fields
GET /v1/projects/{project_id}/usage/fields: {
  end?: string;
  start?: string;
};
end?
optional end?: string;
start?
optional start?: string;
PATCH /v1/projects/{project_id}
PATCH /v1/projects/{project_id}: {
};
PATCH /v1/projects/{project_id}/agent-variables/{variable_id}
PATCH /v1/projects/{project_id}/agent-variables/{variable_id}: {
};
POST /v1/auth/grant
POST /v1/auth/grant: {
};
POST /v1/listen
POST /v1/listen: {
  callback?: string;
  callback_method?: DeepgramSpeechFullApiSchemaV1ListenPostParametersCallbackMethod;
  custom_intent?: DeepgramSpeechFullApiSchemaV1ListenPostParametersCustomIntent;
  custom_intent_mode?: DeepgramSpeechFullApiSchemaV1ListenPostParametersCustomIntentMode;
  custom_topic?: DeepgramSpeechFullApiSchemaV1ListenPostParametersCustomTopic;
  custom_topic_mode?: DeepgramSpeechFullApiSchemaV1ListenPostParametersCustomTopicMode;
  detect_entities?: boolean;
  detect_language?: DeepgramSpeechFullApiSchemaV1ListenPostParametersDetectLanguage;
  diarize?: boolean;
  diarize_model?: DeepgramSpeechFullApiSchemaV1ListenPostParametersDiarizeModel;
  dictation?: boolean;
  encoding?: DeepgramSpeechFullApiSchemaV1ListenPostParametersEncoding;
  extra?: DeepgramSpeechFullApiSchemaV1ListenPostParametersExtra;
  filler_words?: boolean;
  intents?: boolean;
  keyterm?: readonly string[];
  keywords?: DeepgramSpeechFullApiSchemaV1ListenPostParametersKeywords;
  language?: string;
  measurements?: boolean;
  mip_opt_out?: boolean;
  model?: string;
  multichannel?: boolean;
  numerals?: boolean;
  paragraphs?: boolean;
  profanity_filter?: boolean;
  punctuate?: boolean;
  redact?: DeepgramSpeechFullApiSchemaV1ListenPostParametersRedact;
  replace?: DeepgramSpeechFullApiSchemaV1ListenPostParametersReplace;
  search?: DeepgramSpeechFullApiSchemaV1ListenPostParametersSearch;
  sentiment?: boolean;
  smart_format?: boolean;
  summarize?: DeepgramSpeechFullApiSchemaV1ListenPostParametersSummarize;
  tag?: DeepgramSpeechFullApiSchemaV1ListenPostParametersTag;
  topics?: boolean;
  utt_split?: number;
  utterances?: boolean;
  version?: string;
};
callback?
optional callback?: string;
callback_method?
optional callback_method?: DeepgramSpeechFullApiSchemaV1ListenPostParametersCallbackMethod;
custom_intent?
optional custom_intent?: DeepgramSpeechFullApiSchemaV1ListenPostParametersCustomIntent;
custom_intent_mode?
optional custom_intent_mode?: DeepgramSpeechFullApiSchemaV1ListenPostParametersCustomIntentMode;
custom_topic?
optional custom_topic?: DeepgramSpeechFullApiSchemaV1ListenPostParametersCustomTopic;
custom_topic_mode?
optional custom_topic_mode?: DeepgramSpeechFullApiSchemaV1ListenPostParametersCustomTopicMode;
detect_entities?
optional detect_entities?: boolean;
detect_language?
optional detect_language?: DeepgramSpeechFullApiSchemaV1ListenPostParametersDetectLanguage;
diarize?
optional diarize?: boolean;
diarize_model?
optional diarize_model?: DeepgramSpeechFullApiSchemaV1ListenPostParametersDiarizeModel;
dictation?
optional dictation?: boolean;
encoding?
optional encoding?: DeepgramSpeechFullApiSchemaV1ListenPostParametersEncoding;
extra?
optional extra?: DeepgramSpeechFullApiSchemaV1ListenPostParametersExtra;
filler_words?
optional filler_words?: boolean;
intents?
optional intents?: boolean;
keyterm?
optional keyterm?: readonly string[];
keywords?
optional keywords?: DeepgramSpeechFullApiSchemaV1ListenPostParametersKeywords;
language?
optional language?: string;
measurements?
optional measurements?: boolean;
mip_opt_out?
optional mip_opt_out?: boolean;
model?
optional model?: string;
multichannel?
optional multichannel?: boolean;
numerals?
optional numerals?: boolean;
paragraphs?
optional paragraphs?: boolean;
profanity_filter?
optional profanity_filter?: boolean;
punctuate?
optional punctuate?: boolean;
redact?
optional redact?: DeepgramSpeechFullApiSchemaV1ListenPostParametersRedact;
replace?
optional replace?: DeepgramSpeechFullApiSchemaV1ListenPostParametersReplace;
search?
optional search?: DeepgramSpeechFullApiSchemaV1ListenPostParametersSearch;
sentiment?
optional sentiment?: boolean;
smart_format?
optional smart_format?: boolean;
summarize?
optional summarize?: DeepgramSpeechFullApiSchemaV1ListenPostParametersSummarize;
tag?
optional tag?: DeepgramSpeechFullApiSchemaV1ListenPostParametersTag;
topics?
optional topics?: boolean;
utt_split?
optional utt_split?: number;
utterances?
optional utterances?: boolean;
version?
optional version?: string;
POST /v1/projects/{project_id}/agent-variables
POST /v1/projects/{project_id}/agent-variables: {
};
POST /v1/projects/{project_id}/agents
POST /v1/projects/{project_id}/agents: {
};
POST /v1/projects/{project_id}/invites
POST /v1/projects/{project_id}/invites: {
};
POST /v1/projects/{project_id}/keys
POST /v1/projects/{project_id}/keys: {
};
POST /v1/projects/{project_id}/self-hosted/distribution/credentials
POST /v1/projects/{project_id}/self-hosted/distribution/credentials: {
  provider?: "quay";
  scopes?: readonly DeepgramSpeechFullApiSchemaV1ProjectsProjectIdSelfHostedDistributionCredentialsPostParametersScopesSchemaItems[];
};
provider?
optional provider?: "quay";
scopes?
optional scopes?: readonly DeepgramSpeechFullApiSchemaV1ProjectsProjectIdSelfHostedDistributionCredentialsPostParametersScopesSchemaItems[];
POST /v1/read
POST /v1/read: {
  callback?: string;
  callback_method?: DeepgramSpeechFullApiSchemaV1ReadPostParametersCallbackMethod;
  custom_intent?: DeepgramSpeechFullApiSchemaV1ReadPostParametersCustomIntent;
  custom_intent_mode?: DeepgramSpeechFullApiSchemaV1ReadPostParametersCustomIntentMode;
  custom_topic?: DeepgramSpeechFullApiSchemaV1ReadPostParametersCustomTopic;
  custom_topic_mode?: DeepgramSpeechFullApiSchemaV1ReadPostParametersCustomTopicMode;
  intents?: boolean;
  language?: string;
  sentiment?: boolean;
  summarize?: DeepgramSpeechFullApiSchemaV1ReadPostParametersSummarize;
  tag?: DeepgramSpeechFullApiSchemaV1ReadPostParametersTag;
  topics?: boolean;
};
callback?
optional callback?: string;
callback_method?
optional callback_method?: DeepgramSpeechFullApiSchemaV1ReadPostParametersCallbackMethod;
custom_intent?
optional custom_intent?: DeepgramSpeechFullApiSchemaV1ReadPostParametersCustomIntent;
custom_intent_mode?
optional custom_intent_mode?: DeepgramSpeechFullApiSchemaV1ReadPostParametersCustomIntentMode;
custom_topic?
optional custom_topic?: DeepgramSpeechFullApiSchemaV1ReadPostParametersCustomTopic;
custom_topic_mode?
optional custom_topic_mode?: DeepgramSpeechFullApiSchemaV1ReadPostParametersCustomTopicMode;
intents?
optional intents?: boolean;
language?
optional language?: string;
sentiment?
optional sentiment?: boolean;
summarize?
optional summarize?: DeepgramSpeechFullApiSchemaV1ReadPostParametersSummarize;
tag?
optional tag?: DeepgramSpeechFullApiSchemaV1ReadPostParametersTag;
topics?
optional topics?: boolean;
POST /v1/speak
POST /v1/speak: {
  bit_rate?: DeepgramSpeechFullApiSchemaV1SpeakPostParametersBitRate;
  callback?: string;
  callback_method?: DeepgramSpeechFullApiSchemaV1SpeakPostParametersCallbackMethod;
  container?: DeepgramSpeechFullApiSchemaV1SpeakPostParametersContainer;
  encoding?: DeepgramSpeechFullApiSchemaV1SpeakPostParametersEncoding;
  mip_opt_out?: boolean;
  model?: DeepgramSpeechFullApiSchemaV1SpeakPostParametersModel;
  sample_rate?: DeepgramSpeechFullApiSchemaV1SpeakPostParametersSampleRate;
  speed?: number;
  tag?: DeepgramSpeechFullApiSchemaV1SpeakPostParametersTag;
};
bit_rate?
optional bit_rate?: DeepgramSpeechFullApiSchemaV1SpeakPostParametersBitRate;
callback?
optional callback?: string;
callback_method?
optional callback_method?: DeepgramSpeechFullApiSchemaV1SpeakPostParametersCallbackMethod;
container?
optional container?: DeepgramSpeechFullApiSchemaV1SpeakPostParametersContainer;
encoding?
optional encoding?: DeepgramSpeechFullApiSchemaV1SpeakPostParametersEncoding;
mip_opt_out?
optional mip_opt_out?: boolean;
model?
optional model?: DeepgramSpeechFullApiSchemaV1SpeakPostParametersModel;
sample_rate?
optional sample_rate?: DeepgramSpeechFullApiSchemaV1SpeakPostParametersSampleRate;
speed?
optional speed?: number;
tag?
optional tag?: DeepgramSpeechFullApiSchemaV1SpeakPostParametersTag;
PUT /v1/projects/{project_id}/agents/{agent_id}
PUT /v1/projects/{project_id}/agents/{agent_id}: {
};
PUT /v1/projects/{project_id}/members/{member_id}/scopes
PUT /v1/projects/{project_id}/members/{member_id}/scopes: {
};

DeepgramSpeechFullApiOperationQueryRequiredMap

Properties

DELETE /v1/projects/{project_id}
DELETE /v1/projects/{project_id}: false;
DELETE /v1/projects/{project_id}/agent-variables/{variable_id}
DELETE /v1/projects/{project_id}/agent-variables/{variable_id}: false;
DELETE /v1/projects/{project_id}/agents/{agent_id}
DELETE /v1/projects/{project_id}/agents/{agent_id}: false;
DELETE /v1/projects/{project_id}/invites/{email}
DELETE /v1/projects/{project_id}/invites/{email}: false;
DELETE /v1/projects/{project_id}/keys/{key_id}
DELETE /v1/projects/{project_id}/keys/{key_id}: false;
DELETE /v1/projects/{project_id}/leave
DELETE /v1/projects/{project_id}/leave: false;
DELETE /v1/projects/{project_id}/members/{member_id}
DELETE /v1/projects/{project_id}/members/{member_id}: false;
DELETE /v1/projects/{project_id}/self-hosted/distribution/credentials/{distribution_credentials_id}
DELETE /v1/projects/{project_id}/self-hosted/distribution/credentials/{distribution_credentials_id}: false;
GET /v1/agent/settings/think/models
GET /v1/agent/settings/think/models: false;
GET /v1/models
GET /v1/models: false;
GET /v1/models/{model_id}
GET /v1/models/{model_id}: false;
GET /v1/projects
GET /v1/projects: false;
GET /v1/projects/{project_id}
GET /v1/projects/{project_id}: false;
GET /v1/projects/{project_id}/agent-variables
GET /v1/projects/{project_id}/agent-variables: false;
GET /v1/projects/{project_id}/agent-variables/{variable_id}
GET /v1/projects/{project_id}/agent-variables/{variable_id}: false;
GET /v1/projects/{project_id}/agents
GET /v1/projects/{project_id}/agents: false;
GET /v1/projects/{project_id}/agents/{agent_id}
GET /v1/projects/{project_id}/agents/{agent_id}: false;
GET /v1/projects/{project_id}/balances
GET /v1/projects/{project_id}/balances: false;
GET /v1/projects/{project_id}/balances/{balance_id}
GET /v1/projects/{project_id}/balances/{balance_id}: false;
GET /v1/projects/{project_id}/billing/breakdown
GET /v1/projects/{project_id}/billing/breakdown: false;
GET /v1/projects/{project_id}/billing/fields
GET /v1/projects/{project_id}/billing/fields: false;
GET /v1/projects/{project_id}/invites
GET /v1/projects/{project_id}/invites: false;
GET /v1/projects/{project_id}/keys
GET /v1/projects/{project_id}/keys: false;
GET /v1/projects/{project_id}/keys/{key_id}
GET /v1/projects/{project_id}/keys/{key_id}: false;
GET /v1/projects/{project_id}/members
GET /v1/projects/{project_id}/members: false;
GET /v1/projects/{project_id}/members/{member_id}/scopes
GET /v1/projects/{project_id}/members/{member_id}/scopes: false;
GET /v1/projects/{project_id}/models
GET /v1/projects/{project_id}/models: false;
GET /v1/projects/{project_id}/models/{model_id}
GET /v1/projects/{project_id}/models/{model_id}: false;
GET /v1/projects/{project_id}/purchases
GET /v1/projects/{project_id}/purchases: false;
GET /v1/projects/{project_id}/requests
GET /v1/projects/{project_id}/requests: false;
GET /v1/projects/{project_id}/requests/{request_id}
GET /v1/projects/{project_id}/requests/{request_id}: false;
GET /v1/projects/{project_id}/self-hosted/distribution/credentials
GET /v1/projects/{project_id}/self-hosted/distribution/credentials: false;
GET /v1/projects/{project_id}/self-hosted/distribution/credentials/{distribution_credentials_id}
GET /v1/projects/{project_id}/self-hosted/distribution/credentials/{distribution_credentials_id}: false;
GET /v1/projects/{project_id}/usage
GET /v1/projects/{project_id}/usage: false;
GET /v1/projects/{project_id}/usage/breakdown
GET /v1/projects/{project_id}/usage/breakdown: false;
GET /v1/projects/{project_id}/usage/fields
GET /v1/projects/{project_id}/usage/fields: false;
PATCH /v1/projects/{project_id}
PATCH /v1/projects/{project_id}: false;
PATCH /v1/projects/{project_id}/agent-variables/{variable_id}
PATCH /v1/projects/{project_id}/agent-variables/{variable_id}: false;
POST /v1/auth/grant
POST /v1/auth/grant: false;
POST /v1/listen
POST /v1/listen: false;
POST /v1/projects/{project_id}/agent-variables
POST /v1/projects/{project_id}/agent-variables: false;
POST /v1/projects/{project_id}/agents
POST /v1/projects/{project_id}/agents: false;
POST /v1/projects/{project_id}/invites
POST /v1/projects/{project_id}/invites: false;
POST /v1/projects/{project_id}/keys
POST /v1/projects/{project_id}/keys: false;
POST /v1/projects/{project_id}/self-hosted/distribution/credentials
POST /v1/projects/{project_id}/self-hosted/distribution/credentials: false;
POST /v1/read
POST /v1/read: false;
POST /v1/speak
POST /v1/speak: false;
PUT /v1/projects/{project_id}/agents/{agent_id}
PUT /v1/projects/{project_id}/agents/{agent_id}: false;
PUT /v1/projects/{project_id}/members/{member_id}/scopes
PUT /v1/projects/{project_id}/members/{member_id}/scopes: false;

DeepgramSpeechFullApiOperationRequestBodyMap

Properties

DELETE /v1/projects/{project_id}
DELETE /v1/projects/{project_id}: never;
DELETE /v1/projects/{project_id}/agent-variables/{variable_id}
DELETE /v1/projects/{project_id}/agent-variables/{variable_id}: never;
DELETE /v1/projects/{project_id}/agents/{agent_id}
DELETE /v1/projects/{project_id}/agents/{agent_id}: never;
DELETE /v1/projects/{project_id}/invites/{email}
DELETE /v1/projects/{project_id}/invites/{email}: never;
DELETE /v1/projects/{project_id}/keys/{key_id}
DELETE /v1/projects/{project_id}/keys/{key_id}: never;
DELETE /v1/projects/{project_id}/leave
DELETE /v1/projects/{project_id}/leave: never;
DELETE /v1/projects/{project_id}/members/{member_id}
DELETE /v1/projects/{project_id}/members/{member_id}: never;
DELETE /v1/projects/{project_id}/self-hosted/distribution/credentials/{distribution_credentials_id}
DELETE /v1/projects/{project_id}/self-hosted/distribution/credentials/{distribution_credentials_id}: never;
GET /v1/agent/settings/think/models
GET /v1/agent/settings/think/models: never;
GET /v1/models
GET /v1/models: never;
GET /v1/models/{model_id}
GET /v1/models/{model_id}: never;
GET /v1/projects
GET /v1/projects: never;
GET /v1/projects/{project_id}
GET /v1/projects/{project_id}: never;
GET /v1/projects/{project_id}/agent-variables
GET /v1/projects/{project_id}/agent-variables: never;
GET /v1/projects/{project_id}/agent-variables/{variable_id}
GET /v1/projects/{project_id}/agent-variables/{variable_id}: never;
GET /v1/projects/{project_id}/agents
GET /v1/projects/{project_id}/agents: never;
GET /v1/projects/{project_id}/agents/{agent_id}
GET /v1/projects/{project_id}/agents/{agent_id}: never;
GET /v1/projects/{project_id}/balances
GET /v1/projects/{project_id}/balances: never;
GET /v1/projects/{project_id}/balances/{balance_id}
GET /v1/projects/{project_id}/balances/{balance_id}: never;
GET /v1/projects/{project_id}/billing/breakdown
GET /v1/projects/{project_id}/billing/breakdown: never;
GET /v1/projects/{project_id}/billing/fields
GET /v1/projects/{project_id}/billing/fields: never;
GET /v1/projects/{project_id}/invites
GET /v1/projects/{project_id}/invites: never;
GET /v1/projects/{project_id}/keys
GET /v1/projects/{project_id}/keys: never;
GET /v1/projects/{project_id}/keys/{key_id}
GET /v1/projects/{project_id}/keys/{key_id}: never;
GET /v1/projects/{project_id}/members
GET /v1/projects/{project_id}/members: never;
GET /v1/projects/{project_id}/members/{member_id}/scopes
GET /v1/projects/{project_id}/members/{member_id}/scopes: never;
GET /v1/projects/{project_id}/models
GET /v1/projects/{project_id}/models: never;
GET /v1/projects/{project_id}/models/{model_id}
GET /v1/projects/{project_id}/models/{model_id}: never;
GET /v1/projects/{project_id}/purchases
GET /v1/projects/{project_id}/purchases: never;
GET /v1/projects/{project_id}/requests
GET /v1/projects/{project_id}/requests: never;
GET /v1/projects/{project_id}/requests/{request_id}
GET /v1/projects/{project_id}/requests/{request_id}: never;
GET /v1/projects/{project_id}/self-hosted/distribution/credentials
GET /v1/projects/{project_id}/self-hosted/distribution/credentials: never;
GET /v1/projects/{project_id}/self-hosted/distribution/credentials/{distribution_credentials_id}
GET /v1/projects/{project_id}/self-hosted/distribution/credentials/{distribution_credentials_id}: never;
GET /v1/projects/{project_id}/usage
GET /v1/projects/{project_id}/usage: never;
GET /v1/projects/{project_id}/usage/breakdown
GET /v1/projects/{project_id}/usage/breakdown: never;
GET /v1/projects/{project_id}/usage/fields
GET /v1/projects/{project_id}/usage/fields: never;
PATCH /v1/projects/{project_id}
PATCH /v1/projects/{project_id}: DeepgramSpeechFullApiSchemaUpdateProjectV1Request;
PATCH /v1/projects/{project_id}/agent-variables/{variable_id}
PATCH /v1/projects/{project_id}/agent-variables/{variable_id}: DeepgramSpeechFullApiSchemaUpdateAgentVariableV1Request;
POST /v1/auth/grant
POST /v1/auth/grant: DeepgramSpeechFullApiSchemaGrantV1Request;
POST /v1/listen
POST /v1/listen: DeepgramSpeechFullApiSchemaListenV1RequestUrl;
POST /v1/projects/{project_id}/agent-variables
POST /v1/projects/{project_id}/agent-variables: DeepgramSpeechFullApiSchemaCreateAgentVariableV1Request;
POST /v1/projects/{project_id}/agents
POST /v1/projects/{project_id}/agents: DeepgramSpeechFullApiSchemaCreateAgentConfigurationV1Request;
POST /v1/projects/{project_id}/invites
POST /v1/projects/{project_id}/invites: DeepgramSpeechFullApiSchemaCreateProjectInviteV1Request;
POST /v1/projects/{project_id}/keys
POST /v1/projects/{project_id}/keys: DeepgramSpeechFullApiSchemaCreateKeyV1Request;
POST /v1/projects/{project_id}/self-hosted/distribution/credentials
POST /v1/projects/{project_id}/self-hosted/distribution/credentials: DeepgramSpeechFullApiSchemaCreateProjectDistributionCredentialsV1Request;
POST /v1/read
POST /v1/read: DeepgramSpeechFullApiSchemaReadV1Request;
POST /v1/speak
POST /v1/speak: DeepgramSpeechFullApiSchemaSpeakV1Request;
PUT /v1/projects/{project_id}/agents/{agent_id}
PUT /v1/projects/{project_id}/agents/{agent_id}: DeepgramSpeechFullApiSchemaUpdateAgentMetadataV1Request;
PUT /v1/projects/{project_id}/members/{member_id}/scopes
PUT /v1/projects/{project_id}/members/{member_id}/scopes: DeepgramSpeechFullApiSchemaUpdateProjectMemberScopesV1Request;

DeepgramSpeechFullApiOperationRequestBodyRequiredMap

Properties

DELETE /v1/projects/{project_id}
DELETE /v1/projects/{project_id}: false;
DELETE /v1/projects/{project_id}/agent-variables/{variable_id}
DELETE /v1/projects/{project_id}/agent-variables/{variable_id}: false;
DELETE /v1/projects/{project_id}/agents/{agent_id}
DELETE /v1/projects/{project_id}/agents/{agent_id}: false;
DELETE /v1/projects/{project_id}/invites/{email}
DELETE /v1/projects/{project_id}/invites/{email}: false;
DELETE /v1/projects/{project_id}/keys/{key_id}
DELETE /v1/projects/{project_id}/keys/{key_id}: false;
DELETE /v1/projects/{project_id}/leave
DELETE /v1/projects/{project_id}/leave: false;
DELETE /v1/projects/{project_id}/members/{member_id}
DELETE /v1/projects/{project_id}/members/{member_id}: false;
DELETE /v1/projects/{project_id}/self-hosted/distribution/credentials/{distribution_credentials_id}
DELETE /v1/projects/{project_id}/self-hosted/distribution/credentials/{distribution_credentials_id}: false;
GET /v1/agent/settings/think/models
GET /v1/agent/settings/think/models: false;
GET /v1/models
GET /v1/models: false;
GET /v1/models/{model_id}
GET /v1/models/{model_id}: false;
GET /v1/projects
GET /v1/projects: false;
GET /v1/projects/{project_id}
GET /v1/projects/{project_id}: false;
GET /v1/projects/{project_id}/agent-variables
GET /v1/projects/{project_id}/agent-variables: false;
GET /v1/projects/{project_id}/agent-variables/{variable_id}
GET /v1/projects/{project_id}/agent-variables/{variable_id}: false;
GET /v1/projects/{project_id}/agents
GET /v1/projects/{project_id}/agents: false;
GET /v1/projects/{project_id}/agents/{agent_id}
GET /v1/projects/{project_id}/agents/{agent_id}: false;
GET /v1/projects/{project_id}/balances
GET /v1/projects/{project_id}/balances: false;
GET /v1/projects/{project_id}/balances/{balance_id}
GET /v1/projects/{project_id}/balances/{balance_id}: false;
GET /v1/projects/{project_id}/billing/breakdown
GET /v1/projects/{project_id}/billing/breakdown: false;
GET /v1/projects/{project_id}/billing/fields
GET /v1/projects/{project_id}/billing/fields: false;
GET /v1/projects/{project_id}/invites
GET /v1/projects/{project_id}/invites: false;
GET /v1/projects/{project_id}/keys
GET /v1/projects/{project_id}/keys: false;
GET /v1/projects/{project_id}/keys/{key_id}
GET /v1/projects/{project_id}/keys/{key_id}: false;
GET /v1/projects/{project_id}/members
GET /v1/projects/{project_id}/members: false;
GET /v1/projects/{project_id}/members/{member_id}/scopes
GET /v1/projects/{project_id}/members/{member_id}/scopes: false;
GET /v1/projects/{project_id}/models
GET /v1/projects/{project_id}/models: false;
GET /v1/projects/{project_id}/models/{model_id}
GET /v1/projects/{project_id}/models/{model_id}: false;
GET /v1/projects/{project_id}/purchases
GET /v1/projects/{project_id}/purchases: false;
GET /v1/projects/{project_id}/requests
GET /v1/projects/{project_id}/requests: false;
GET /v1/projects/{project_id}/requests/{request_id}
GET /v1/projects/{project_id}/requests/{request_id}: false;
GET /v1/projects/{project_id}/self-hosted/distribution/credentials
GET /v1/projects/{project_id}/self-hosted/distribution/credentials: false;
GET /v1/projects/{project_id}/self-hosted/distribution/credentials/{distribution_credentials_id}
GET /v1/projects/{project_id}/self-hosted/distribution/credentials/{distribution_credentials_id}: false;
GET /v1/projects/{project_id}/usage
GET /v1/projects/{project_id}/usage: false;
GET /v1/projects/{project_id}/usage/breakdown
GET /v1/projects/{project_id}/usage/breakdown: false;
GET /v1/projects/{project_id}/usage/fields
GET /v1/projects/{project_id}/usage/fields: false;
PATCH /v1/projects/{project_id}
PATCH /v1/projects/{project_id}: false;
PATCH /v1/projects/{project_id}/agent-variables/{variable_id}
PATCH /v1/projects/{project_id}/agent-variables/{variable_id}: false;
POST /v1/auth/grant
POST /v1/auth/grant: false;
POST /v1/listen
POST /v1/listen: false;
POST /v1/projects/{project_id}/agent-variables
POST /v1/projects/{project_id}/agent-variables: false;
POST /v1/projects/{project_id}/agents
POST /v1/projects/{project_id}/agents: false;
POST /v1/projects/{project_id}/invites
POST /v1/projects/{project_id}/invites: false;
POST /v1/projects/{project_id}/keys
POST /v1/projects/{project_id}/keys: false;
POST /v1/projects/{project_id}/self-hosted/distribution/credentials
POST /v1/projects/{project_id}/self-hosted/distribution/credentials: false;
POST /v1/read
POST /v1/read: false;
POST /v1/speak
POST /v1/speak: false;
PUT /v1/projects/{project_id}/agents/{agent_id}
PUT /v1/projects/{project_id}/agents/{agent_id}: false;
PUT /v1/projects/{project_id}/members/{member_id}/scopes
PUT /v1/projects/{project_id}/members/{member_id}/scopes: false;

DeepgramSpeechFullApiOperationResponseMap

Properties

DELETE /v1/projects/{project_id}
DELETE /v1/projects/{project_id}: DeepgramSpeechFullApiSchemaDeleteProjectV1Response;
DELETE /v1/projects/{project_id}/agent-variables/{variable_id}
DELETE /v1/projects/{project_id}/agent-variables/{variable_id}: DeepgramSpeechFullApiSchemaDeleteAgentVariableV1Response;
DELETE /v1/projects/{project_id}/agents/{agent_id}
DELETE /v1/projects/{project_id}/agents/{agent_id}: DeepgramSpeechFullApiSchemaDeleteAgentConfigurationV1Response;
DELETE /v1/projects/{project_id}/invites/{email}
DELETE /v1/projects/{project_id}/invites/{email}: DeepgramSpeechFullApiSchemaDeleteProjectInviteV1Response;
DELETE /v1/projects/{project_id}/keys/{key_id}
DELETE /v1/projects/{project_id}/keys/{key_id}: DeepgramSpeechFullApiSchemaDeleteProjectKeyV1Response;
DELETE /v1/projects/{project_id}/leave
DELETE /v1/projects/{project_id}/leave: DeepgramSpeechFullApiSchemaLeaveProjectV1Response;
DELETE /v1/projects/{project_id}/members/{member_id}
DELETE /v1/projects/{project_id}/members/{member_id}: DeepgramSpeechFullApiSchemaDeleteProjectMemberV1Response;
DELETE /v1/projects/{project_id}/self-hosted/distribution/credentials/{distribution_credentials_id}
DELETE /v1/projects/{project_id}/self-hosted/distribution/credentials/{distribution_credentials_id}: DeepgramSpeechFullApiSchemaGetProjectDistributionCredentialsV1Response;
GET /v1/agent/settings/think/models
GET /v1/agent/settings/think/models: DeepgramSpeechFullApiSchemaAgentThinkModelsV1Response;
GET /v1/models
GET /v1/models: DeepgramSpeechFullApiSchemaListModelsV1Response;
GET /v1/models/{model_id}
GET /v1/models/{model_id}: DeepgramSpeechFullApiSchemaGetModelV1Response;
GET /v1/projects
GET /v1/projects: DeepgramSpeechFullApiSchemaListProjectsV1Response;
GET /v1/projects/{project_id}
GET /v1/projects/{project_id}: DeepgramSpeechFullApiSchemaGetProjectV1Response;
GET /v1/projects/{project_id}/agent-variables
GET /v1/projects/{project_id}/agent-variables: DeepgramSpeechFullApiSchemaListAgentVariablesV1Response;
GET /v1/projects/{project_id}/agent-variables/{variable_id}
GET /v1/projects/{project_id}/agent-variables/{variable_id}: DeepgramSpeechFullApiSchemaAgentVariableV1;
GET /v1/projects/{project_id}/agents
GET /v1/projects/{project_id}/agents: DeepgramSpeechFullApiSchemaListAgentConfigurationsV1Response;
GET /v1/projects/{project_id}/agents/{agent_id}
GET /v1/projects/{project_id}/agents/{agent_id}: DeepgramSpeechFullApiSchemaAgentConfigurationV1;
GET /v1/projects/{project_id}/balances
GET /v1/projects/{project_id}/balances: DeepgramSpeechFullApiSchemaListProjectBalancesV1Response;
GET /v1/projects/{project_id}/balances/{balance_id}
GET /v1/projects/{project_id}/balances/{balance_id}: DeepgramSpeechFullApiSchemaGetProjectBalanceV1Response;
GET /v1/projects/{project_id}/billing/breakdown
GET /v1/projects/{project_id}/billing/breakdown: DeepgramSpeechFullApiSchemaBillingBreakdownV1Response;
GET /v1/projects/{project_id}/billing/fields
GET /v1/projects/{project_id}/billing/fields: DeepgramSpeechFullApiSchemaListBillingFieldsV1Response;
GET /v1/projects/{project_id}/invites
GET /v1/projects/{project_id}/invites: DeepgramSpeechFullApiSchemaListProjectInvitesV1Response;
GET /v1/projects/{project_id}/keys
GET /v1/projects/{project_id}/keys: DeepgramSpeechFullApiSchemaListProjectKeysV1Response;
GET /v1/projects/{project_id}/keys/{key_id}
GET /v1/projects/{project_id}/keys/{key_id}: DeepgramSpeechFullApiSchemaGetProjectKeyV1Response;
GET /v1/projects/{project_id}/members
GET /v1/projects/{project_id}/members: DeepgramSpeechFullApiSchemaListProjectMembersV1Response;
GET /v1/projects/{project_id}/members/{member_id}/scopes
GET /v1/projects/{project_id}/members/{member_id}/scopes: DeepgramSpeechFullApiSchemaListProjectMemberScopesV1Response;
GET /v1/projects/{project_id}/models
GET /v1/projects/{project_id}/models: DeepgramSpeechFullApiSchemaListModelsV1Response;
GET /v1/projects/{project_id}/models/{model_id}
GET /v1/projects/{project_id}/models/{model_id}: DeepgramSpeechFullApiSchemaGetModelV1Response;
GET /v1/projects/{project_id}/purchases
GET /v1/projects/{project_id}/purchases: DeepgramSpeechFullApiSchemaListProjectPurchasesV1Response;
GET /v1/projects/{project_id}/requests
GET /v1/projects/{project_id}/requests: DeepgramSpeechFullApiSchemaListProjectRequestsV1Response;
GET /v1/projects/{project_id}/requests/{request_id}
GET /v1/projects/{project_id}/requests/{request_id}: DeepgramSpeechFullApiSchemaGetProjectRequestV1Response;
GET /v1/projects/{project_id}/self-hosted/distribution/credentials
GET /v1/projects/{project_id}/self-hosted/distribution/credentials: DeepgramSpeechFullApiSchemaListProjectDistributionCredentialsV1Response;
GET /v1/projects/{project_id}/self-hosted/distribution/credentials/{distribution_credentials_id}
GET /v1/projects/{project_id}/self-hosted/distribution/credentials/{distribution_credentials_id}: DeepgramSpeechFullApiSchemaGetProjectDistributionCredentialsV1Response;
GET /v1/projects/{project_id}/usage
GET /v1/projects/{project_id}/usage: DeepgramSpeechFullApiSchemaUsageV1Response;
GET /v1/projects/{project_id}/usage/breakdown
GET /v1/projects/{project_id}/usage/breakdown: DeepgramSpeechFullApiSchemaUsageBreakdownV1Response;
GET /v1/projects/{project_id}/usage/fields
GET /v1/projects/{project_id}/usage/fields: DeepgramSpeechFullApiSchemaUsageFieldsV1Response;
PATCH /v1/projects/{project_id}
PATCH /v1/projects/{project_id}: DeepgramSpeechFullApiSchemaUpdateProjectV1Response;
PATCH /v1/projects/{project_id}/agent-variables/{variable_id}
PATCH /v1/projects/{project_id}/agent-variables/{variable_id}: DeepgramSpeechFullApiSchemaAgentVariableV1;
POST /v1/auth/grant
POST /v1/auth/grant: DeepgramSpeechFullApiSchemaGrantV1Response;
POST /v1/listen
POST /v1/listen: DeepgramSpeechFullApiSchemaListenV1MediaTranscribeResponse200;
POST /v1/projects/{project_id}/agent-variables
POST /v1/projects/{project_id}/agent-variables: DeepgramSpeechFullApiSchemaAgentVariableV1;
POST /v1/projects/{project_id}/agents
POST /v1/projects/{project_id}/agents: DeepgramSpeechFullApiSchemaCreateAgentConfigurationV1Response;
POST /v1/projects/{project_id}/invites
POST /v1/projects/{project_id}/invites: DeepgramSpeechFullApiSchemaCreateProjectInviteV1Response;
POST /v1/projects/{project_id}/keys
POST /v1/projects/{project_id}/keys: DeepgramSpeechFullApiSchemaCreateKeyV1Response;
POST /v1/projects/{project_id}/self-hosted/distribution/credentials
POST /v1/projects/{project_id}/self-hosted/distribution/credentials: DeepgramSpeechFullApiSchemaCreateProjectDistributionCredentialsV1Response;
POST /v1/read
POST /v1/read: DeepgramSpeechFullApiSchemaReadV1Response;
POST /v1/speak
POST /v1/speak: DeepgramSpeechFullApiSchemaSpeakV1AudioGenerateResponse200;
PUT /v1/projects/{project_id}/agents/{agent_id}
PUT /v1/projects/{project_id}/agents/{agent_id}: DeepgramSpeechFullApiSchemaAgentConfigurationV1;
PUT /v1/projects/{project_id}/members/{member_id}/scopes
PUT /v1/projects/{project_id}/members/{member_id}/scopes: DeepgramSpeechFullApiSchemaUpdateProjectMemberScopesV1Response;

DeepgramSpeechJsonObject

Indexable

[key: string]: DeepgramSpeechJsonValue

DeepgramSpeechOperationRequestInput

Properties

body?
optional body?:
  | ArrayBuffer
  | Uint8Array<ArrayBufferLike>
  | FormData
  | DeepgramSpeechJsonValue;
contentType?
optional contentType?: string;
headers?
optional headers?: Record<string, string>;
pathParams?
optional pathParams?: Record<string, string | number>;
query?
optional query?: Record<string, DeepgramSpeechJsonValue | undefined>;
responseType?
optional responseType?: "response" | "json" | "arrayBuffer" | "stream";

DeepgramSpeechVoiceProviderOptions

Extends

  • Omit\<Partial\<SpeechPipelineVoiceProviderOptions>, "provider" | "transcriptionSource" | "transcribe" | "synthesize">

Properties

apiBaseUrl?
optional apiBaseUrl?: string;
apiKey?
optional apiKey?: string;
client?
optional client?: DeepgramSpeechClient;
container?
optional container?: string;
detectLanguage?
optional detectLanguage?: boolean;
encoding?
optional encoding?: string;
endSilenceMs?
optional endSilenceMs?: number;
Inherited from
Omit.endSilenceMs
fetch?
optional fetch?: {
  (input, init?): Promise<Response>;
  (input, init?): Promise<Response>;
};
Call Signature
(input, init?): Promise<Response>;

MDN Reference

Parameters
Parameter Type
input URL | RequestInfo
init? RequestInit
Returns

Promise\<Response>

Call Signature
(input, init?): Promise<Response>;

MDN Reference

Parameters
Parameter Type
input string | Request | URL
init? RequestInit
Returns

Promise\<Response>

id?
optional id?: string;
Inherited from
Omit.id
language?
optional language?: string;
maxSpeechMs?
optional maxSpeechMs?: number;
Inherited from
Omit.maxSpeechMs
minSpeechMs?
optional minSpeechMs?: number;
Inherited from
Omit.minSpeechMs
model?
optional model?: string;
Inherited from
Omit.model
outputSampleRate?
optional outputSampleRate?: number;
punctuate?
optional punctuate?: boolean;
sampleRate?
optional sampleRate?: number;
Inherited from
Omit.sampleRate
silenceThreshold?
optional silenceThreshold?: number;
Inherited from
Omit.silenceThreshold
smartFormat?
optional smartFormat?: boolean;
speechToTextModel?
optional speechToTextModel?: string;
textToSpeechModel?
optional textToSpeechModel?: string;

DeepgramTextToSpeechInput

Properties

container?
optional container?: string;
encoding?
optional encoding?: string;
model?
optional model?: string;
sampleRate?
optional sampleRate?: number;
signal?
optional signal?: AbortSignal;
text
text: string;

DeepgramTextToSpeechResult

Properties

audio
audio: ArrayBuffer;
charCount?
optional charCount?: number;
contentType?
optional contentType?: string;
modelName?
optional modelName?: string;
modelUuid?
optional modelUuid?: string;
requestId?
optional requestId?: string;

DeepgramTranscribeAudioInput

Properties

audio
audio: Uint8Array;
detectLanguage?
optional detectLanguage?: boolean;
language?
optional language?: string;
model?
optional model?: string;
punctuate?
optional punctuate?: boolean;
sampleRate?
optional sampleRate?: number;
signal?
optional signal?: AbortSignal;
smartFormat?
optional smartFormat?: boolean;

DeepgramTranscriptionResult

Properties

channels?
optional channels?: number;
confidence?
optional confidence?: number;
duration?
optional duration?: number;
modelName?
optional modelName?: string;
raw?
optional raw?: DeepgramSpeechJsonObject;
requestId?
optional requestId?: string;
text
text: string;

Type Aliases

DeepgramAudioContainer

type DeepgramAudioContainer = "wav" | "none" | "ogg" | string;

DeepgramAudioEncoding

type DeepgramAudioEncoding = "linear16" | "mulaw" | "alaw" | "mp3" | "opus" | "flac" | "aac" | string;

DeepgramSpeechFullApiOperationId

type DeepgramSpeechFullApiOperationId = typeof DEEPGRAM_SPEECH_FULL_API_OPERATION_OPERATION_IDS[number];

DeepgramSpeechFullApiOperationMethod

type DeepgramSpeechFullApiOperationMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";

DeepgramSpeechFullApiSchemaAgentConfigurationV1

type DeepgramSpeechFullApiSchemaAgentConfigurationV1 = {
  agent_id: string;
  config: DeepgramSpeechFullApiSchemaAgentConfigurationV1Config;
  created_at?: string;
  metadata?: {
   [key: string]: string;
  };
  updated_at?: string;
};

Properties

agent_id
agent_id: string;
config
config: DeepgramSpeechFullApiSchemaAgentConfigurationV1Config;
created_at?
optional created_at?: string;
metadata?
optional metadata?: {
[key: string]: string;
};
Index Signature
[key: string]: string
updated_at?
optional updated_at?: string;

DeepgramSpeechFullApiSchemaAgentConfigurationV1Config

type DeepgramSpeechFullApiSchemaAgentConfigurationV1Config = {
};

DeepgramSpeechFullApiSchemaAgentThinkModelsV1Response

type DeepgramSpeechFullApiSchemaAgentThinkModelsV1Response = {
  models: ReadonlyArray<DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItems>;
};

Properties

models
models: ReadonlyArray<DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItems>;

DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItems

type DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItems =
  | DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItems0
  | DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItems1
  | DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItems2
  | DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItems3
  | DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItems4;

DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItems0

type DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItems0 = {
  id: DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItemsOneOf0Id;
  name: string;
  provider: DeepgramSpeechFullApiSchemaJsonValue;
};

Properties

id
id: DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItemsOneOf0Id;
name
name: string;
provider
provider: DeepgramSpeechFullApiSchemaJsonValue;

DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItems1

type DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItems1 = {
  id: DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItemsOneOf1Id;
  name: string;
  provider: DeepgramSpeechFullApiSchemaJsonValue;
};

Properties

id
id: DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItemsOneOf1Id;
name
name: string;
provider
provider: DeepgramSpeechFullApiSchemaJsonValue;

DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItems2

type DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItems2 = {
  id: DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItemsOneOf2Id;
  name: string;
  provider: DeepgramSpeechFullApiSchemaJsonValue;
};

Properties

id
id: DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItemsOneOf2Id;
name
name: string;
provider
provider: DeepgramSpeechFullApiSchemaJsonValue;

DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItems3

type DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItems3 = {
  id: DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItemsOneOf3Id;
  name: string;
  provider: DeepgramSpeechFullApiSchemaJsonValue;
};

Properties

id
id: DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItemsOneOf3Id;
name
name: string;
provider
provider: DeepgramSpeechFullApiSchemaJsonValue;

DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItems4

type DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItems4 = {
  id: string;
  name: string;
  provider: DeepgramSpeechFullApiSchemaJsonValue;
};

Properties

id
id: string;
name
name: string;
provider
provider: DeepgramSpeechFullApiSchemaJsonValue;

DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItemsOneOf0Id

type DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItemsOneOf0Id =
  | "gpt-5"
  | "gpt-5-mini"
  | "gpt-5-nano"
  | "gpt-4.1"
  | "gpt-4.1-mini"
  | "gpt-4.1-nano"
  | "gpt-4o"
  | "gpt-4o-mini";

DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItemsOneOf1Id

type DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItemsOneOf1Id = "claude-3-5-haiku-latest" | "claude-sonnet-4-20250514";

DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItemsOneOf2Id

type DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItemsOneOf2Id = "gemini-2.5-flash" | "gemini-2.0-flash" | "gemini-2.0-flash-lite";

DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItemsOneOf3Id

type DeepgramSpeechFullApiSchemaAgentThinkModelsV1ResponseModelsItemsOneOf3Id = "openai/gpt-oss-20b";

DeepgramSpeechFullApiSchemaAgentVariableV1

type DeepgramSpeechFullApiSchemaAgentVariableV1 = {
  created_at?: string;
  key: string;
  updated_at?: string;
  value: DeepgramSpeechFullApiSchemaJsonValue;
  variable_id: string;
};

Properties

created_at?
optional created_at?: string;
key
key: string;
updated_at?
optional updated_at?: string;
value
value: DeepgramSpeechFullApiSchemaJsonValue;
variable_id
variable_id: string;

DeepgramSpeechFullApiSchemaBillingBreakdownV1Response

type DeepgramSpeechFullApiSchemaBillingBreakdownV1Response = {
  end: string;
  resolution: DeepgramSpeechFullApiSchemaBillingBreakdownV1ResponseResolution;
  results: ReadonlyArray<DeepgramSpeechFullApiSchemaBillingBreakdownV1ResponseResultsItems>;
  start: string;
};

Properties

end
end: string;
resolution
resolution: DeepgramSpeechFullApiSchemaBillingBreakdownV1ResponseResolution;
results
results: ReadonlyArray<DeepgramSpeechFullApiSchemaBillingBreakdownV1ResponseResultsItems>;
start
start: string;

DeepgramSpeechFullApiSchemaBillingBreakdownV1ResponseResolution

type DeepgramSpeechFullApiSchemaBillingBreakdownV1ResponseResolution = {
  amount: number;
  units: string;
};

Properties

amount
amount: number;
units
units: string;

DeepgramSpeechFullApiSchemaBillingBreakdownV1ResponseResultsItems

type DeepgramSpeechFullApiSchemaBillingBreakdownV1ResponseResultsItems = {
  dollars: number;
  grouping: DeepgramSpeechFullApiSchemaBillingBreakdownV1ResponseResultsItemsGrouping;
};

Properties

dollars
dollars: number;
grouping
grouping: DeepgramSpeechFullApiSchemaBillingBreakdownV1ResponseResultsItemsGrouping;

DeepgramSpeechFullApiSchemaBillingBreakdownV1ResponseResultsItemsGrouping

type DeepgramSpeechFullApiSchemaBillingBreakdownV1ResponseResultsItemsGrouping = {
  accessor?: string | null;
  deployment?: string | null;
  end?: string;
  line_item?: string | null;
  start?: string;
  tags?: ReadonlyArray<string> | null;
};

Properties

accessor?
optional accessor?: string | null;
deployment?
optional deployment?: string | null;
end?
optional end?: string;
line_item?
optional line_item?: string | null;
start?
optional start?: string;
tags?
optional tags?: ReadonlyArray<string> | null;

DeepgramSpeechFullApiSchemaCreateAgentConfigurationV1Request

type DeepgramSpeechFullApiSchemaCreateAgentConfigurationV1Request = {
  api_version?: number;
  config: string;
  metadata?: {
   [key: string]: string;
  };
};

Properties

api_version?
optional api_version?: number;
config
config: string;
metadata?
optional metadata?: {
[key: string]: string;
};
Index Signature
[key: string]: string

DeepgramSpeechFullApiSchemaCreateAgentConfigurationV1Response

type DeepgramSpeechFullApiSchemaCreateAgentConfigurationV1Response = {
  agent_id: string;
  config: DeepgramSpeechFullApiSchemaCreateAgentConfigurationV1ResponseConfig;
  metadata?: {
   [key: string]: string;
  };
};

Properties

agent_id
agent_id: string;
config
config: DeepgramSpeechFullApiSchemaCreateAgentConfigurationV1ResponseConfig;
metadata?
optional metadata?: {
[key: string]: string;
};
Index Signature
[key: string]: string

DeepgramSpeechFullApiSchemaCreateAgentConfigurationV1ResponseConfig

type DeepgramSpeechFullApiSchemaCreateAgentConfigurationV1ResponseConfig = {
};

DeepgramSpeechFullApiSchemaCreateAgentVariableV1Request

type DeepgramSpeechFullApiSchemaCreateAgentVariableV1Request = {
  api_version?: number;
  key: string;
  value: DeepgramSpeechFullApiSchemaJsonValue;
};

Properties

api_version?
optional api_version?: number;
key
key: string;
value
value: DeepgramSpeechFullApiSchemaJsonValue;

DeepgramSpeechFullApiSchemaCreateKeyV1Request

type DeepgramSpeechFullApiSchemaCreateKeyV1Request =
  | DeepgramSpeechFullApiSchemaJsonValue
  | DeepgramSpeechFullApiSchemaJsonValue;

DeepgramSpeechFullApiSchemaCreateKeyV1Response

type DeepgramSpeechFullApiSchemaCreateKeyV1Response = {
  api_key_id?: string;
  comment?: string;
  expiration_date?: string;
  key?: string;
  scopes?: ReadonlyArray<string>;
  tags?: ReadonlyArray<string>;
};

Properties

api_key_id?
optional api_key_id?: string;
comment?
optional comment?: string;
expiration_date?
optional expiration_date?: string;
key?
optional key?: string;
scopes?
optional scopes?: ReadonlyArray<string>;
tags?
optional tags?: ReadonlyArray<string>;

DeepgramSpeechFullApiSchemaCreateProjectDistributionCredentialsV1Request

type DeepgramSpeechFullApiSchemaCreateProjectDistributionCredentialsV1Request = {
  comment?: string;
};

Properties

comment?
optional comment?: string;

DeepgramSpeechFullApiSchemaCreateProjectDistributionCredentialsV1Response

type DeepgramSpeechFullApiSchemaCreateProjectDistributionCredentialsV1Response = {
  distribution_credentials: DeepgramSpeechFullApiSchemaCreateProjectDistributionCredentialsV1ResponseDistributionCredentials;
  member: DeepgramSpeechFullApiSchemaCreateProjectDistributionCredentialsV1ResponseMember;
};

Properties

distribution_credentials
distribution_credentials: DeepgramSpeechFullApiSchemaCreateProjectDistributionCredentialsV1ResponseDistributionCredentials;
member
member: DeepgramSpeechFullApiSchemaCreateProjectDistributionCredentialsV1ResponseMember;

DeepgramSpeechFullApiSchemaCreateProjectDistributionCredentialsV1ResponseDistributionCredentials

type DeepgramSpeechFullApiSchemaCreateProjectDistributionCredentialsV1ResponseDistributionCredentials = {
  comment?: string;
  created: string;
  distribution_credentials_id: string;
  provider: string;
  scopes: ReadonlyArray<string>;
};

Properties

comment?
optional comment?: string;
created
created: string;
distribution_credentials_id
distribution_credentials_id: string;
provider
provider: string;
scopes
scopes: ReadonlyArray<string>;

DeepgramSpeechFullApiSchemaCreateProjectDistributionCredentialsV1ResponseMember

type DeepgramSpeechFullApiSchemaCreateProjectDistributionCredentialsV1ResponseMember = {
  email: string;
  member_id: string;
};

Properties

email
email: string;
member_id
member_id: string;

DeepgramSpeechFullApiSchemaCreateProjectInviteV1Request

type DeepgramSpeechFullApiSchemaCreateProjectInviteV1Request = {
  email: string;
  scope: string;
};

Properties

email
email: string;
scope
scope: string;

DeepgramSpeechFullApiSchemaCreateProjectInviteV1Response

type DeepgramSpeechFullApiSchemaCreateProjectInviteV1Response = {
  message?: string;
};

Properties

message?
optional message?: string;

DeepgramSpeechFullApiSchemaDeleteAgentConfigurationV1Response

type DeepgramSpeechFullApiSchemaDeleteAgentConfigurationV1Response = {
};

DeepgramSpeechFullApiSchemaDeleteAgentVariableV1Response

type DeepgramSpeechFullApiSchemaDeleteAgentVariableV1Response = {
};

DeepgramSpeechFullApiSchemaDeleteProjectInviteV1Response

type DeepgramSpeechFullApiSchemaDeleteProjectInviteV1Response = {
  message?: string;
};

Properties

message?
optional message?: string;

DeepgramSpeechFullApiSchemaDeleteProjectKeyV1Response

type DeepgramSpeechFullApiSchemaDeleteProjectKeyV1Response = {
  message?: string;
};

Properties

message?
optional message?: string;

DeepgramSpeechFullApiSchemaDeleteProjectMemberV1Response

type DeepgramSpeechFullApiSchemaDeleteProjectMemberV1Response = {
  message?: string;
};

Properties

message?
optional message?: string;

DeepgramSpeechFullApiSchemaDeleteProjectV1Response

type DeepgramSpeechFullApiSchemaDeleteProjectV1Response = {
  message?: string;
};

Properties

message?
optional message?: string;

DeepgramSpeechFullApiSchemaGetModelV1Response

type DeepgramSpeechFullApiSchemaGetModelV1Response =
  | DeepgramSpeechFullApiSchemaGetModelV1Response0
  | DeepgramSpeechFullApiSchemaGetModelV1Response1;

DeepgramSpeechFullApiSchemaGetModelV1Response0

type DeepgramSpeechFullApiSchemaGetModelV1Response0 = {
  architecture?: string;
  batch?: boolean;
  canonical_name?: string;
  formatted_output?: boolean;
  languages?: ReadonlyArray<string>;
  name?: string;
  streaming?: boolean;
  uuid?: string;
  version?: string;
};

Properties

architecture?
optional architecture?: string;
batch?
optional batch?: boolean;
canonical_name?
optional canonical_name?: string;
formatted_output?
optional formatted_output?: boolean;
languages?
optional languages?: ReadonlyArray<string>;
name?
optional name?: string;
streaming?
optional streaming?: boolean;
uuid?
optional uuid?: string;
version?
optional version?: string;

DeepgramSpeechFullApiSchemaGetModelV1Response1

type DeepgramSpeechFullApiSchemaGetModelV1Response1 = {
  architecture?: string;
  canonical_name?: string;
  languages?: ReadonlyArray<string>;
  metadata?: DeepgramSpeechFullApiSchemaGetModelV1ResponseOneOf1Metadata;
  name?: string;
  uuid?: string;
  version?: string;
};

Properties

architecture?
optional architecture?: string;
canonical_name?
optional canonical_name?: string;
languages?
optional languages?: ReadonlyArray<string>;
metadata?
optional metadata?: DeepgramSpeechFullApiSchemaGetModelV1ResponseOneOf1Metadata;
name?
optional name?: string;
uuid?
optional uuid?: string;
version?
optional version?: string;

DeepgramSpeechFullApiSchemaGetModelV1ResponseOneOf1Metadata

type DeepgramSpeechFullApiSchemaGetModelV1ResponseOneOf1Metadata = {
  accent?: string;
  age?: string;
  color?: string;
  image?: string;
  sample?: string;
  tags?: ReadonlyArray<string>;
  use_cases?: ReadonlyArray<string>;
};

Properties

accent?
optional accent?: string;
age?
optional age?: string;
color?
optional color?: string;
image?
optional image?: string;
sample?
optional sample?: string;
tags?
optional tags?: ReadonlyArray<string>;
use_cases?
optional use_cases?: ReadonlyArray<string>;

DeepgramSpeechFullApiSchemaGetProjectBalanceV1Response

type DeepgramSpeechFullApiSchemaGetProjectBalanceV1Response = {
  amount?: number;
  balance_id?: string;
  purchase_order_id?: string;
  units?: string;
};

Properties

amount?
optional amount?: number;
balance_id?
optional balance_id?: string;
purchase_order_id?
optional purchase_order_id?: string;
units?
optional units?: string;

DeepgramSpeechFullApiSchemaGetProjectDistributionCredentialsV1Response

type DeepgramSpeechFullApiSchemaGetProjectDistributionCredentialsV1Response = {
  distribution_credentials: DeepgramSpeechFullApiSchemaGetProjectDistributionCredentialsV1ResponseDistributionCredentials;
  member: DeepgramSpeechFullApiSchemaGetProjectDistributionCredentialsV1ResponseMember;
};

Properties

distribution_credentials
distribution_credentials: DeepgramSpeechFullApiSchemaGetProjectDistributionCredentialsV1ResponseDistributionCredentials;
member
member: DeepgramSpeechFullApiSchemaGetProjectDistributionCredentialsV1ResponseMember;

DeepgramSpeechFullApiSchemaGetProjectDistributionCredentialsV1ResponseDistributionCredentials

type DeepgramSpeechFullApiSchemaGetProjectDistributionCredentialsV1ResponseDistributionCredentials = {
  comment?: string;
  created: string;
  distribution_credentials_id: string;
  provider: string;
  scopes: ReadonlyArray<string>;
};

Properties

comment?
optional comment?: string;
created
created: string;
distribution_credentials_id
distribution_credentials_id: string;
provider
provider: string;
scopes
scopes: ReadonlyArray<string>;

DeepgramSpeechFullApiSchemaGetProjectDistributionCredentialsV1ResponseMember

type DeepgramSpeechFullApiSchemaGetProjectDistributionCredentialsV1ResponseMember = {
  email: string;
  member_id: string;
};

Properties

email
email: string;
member_id
member_id: string;

DeepgramSpeechFullApiSchemaGetProjectKeyV1Response

type DeepgramSpeechFullApiSchemaGetProjectKeyV1Response = {
  item?: DeepgramSpeechFullApiSchemaGetProjectKeyV1ResponseItem;
};

Properties

item?
optional item?: DeepgramSpeechFullApiSchemaGetProjectKeyV1ResponseItem;

DeepgramSpeechFullApiSchemaGetProjectKeyV1ResponseItem

type DeepgramSpeechFullApiSchemaGetProjectKeyV1ResponseItem = {
  member?: DeepgramSpeechFullApiSchemaGetProjectKeyV1ResponseItemMember;
};

Properties

member?
optional member?: DeepgramSpeechFullApiSchemaGetProjectKeyV1ResponseItemMember;

DeepgramSpeechFullApiSchemaGetProjectKeyV1ResponseItemMember

type DeepgramSpeechFullApiSchemaGetProjectKeyV1ResponseItemMember = {
  api_key?: DeepgramSpeechFullApiSchemaGetProjectKeyV1ResponseItemMemberApiKey;
  email?: string;
  first_name?: string;
  last_name?: string;
  member_id?: string;
};

Properties

api_key?
optional api_key?: DeepgramSpeechFullApiSchemaGetProjectKeyV1ResponseItemMemberApiKey;
email?
optional email?: string;
first_name?
optional first_name?: string;
last_name?
optional last_name?: string;
member_id?
optional member_id?: string;

DeepgramSpeechFullApiSchemaGetProjectKeyV1ResponseItemMemberApiKey

type DeepgramSpeechFullApiSchemaGetProjectKeyV1ResponseItemMemberApiKey = {
  api_key_id?: string;
  comment?: string;
  created?: string;
  expiration_date?: string;
  scopes?: ReadonlyArray<string>;
  tags?: ReadonlyArray<string>;
};

Properties

api_key_id?
optional api_key_id?: string;
comment?
optional comment?: string;
created?
optional created?: string;
expiration_date?
optional expiration_date?: string;
scopes?
optional scopes?: ReadonlyArray<string>;
tags?
optional tags?: ReadonlyArray<string>;

DeepgramSpeechFullApiSchemaGetProjectRequestV1Response

type DeepgramSpeechFullApiSchemaGetProjectRequestV1Response = {
  request?: DeepgramSpeechFullApiSchemaProjectRequestResponse;
};

Properties

request?
optional request?: DeepgramSpeechFullApiSchemaProjectRequestResponse;

DeepgramSpeechFullApiSchemaGetProjectV1Response

type DeepgramSpeechFullApiSchemaGetProjectV1Response = {
  mip_opt_out?: boolean;
  name?: string;
  project_id?: string;
};

Properties

mip_opt_out?
optional mip_opt_out?: boolean;
name?
optional name?: string;
project_id?
optional project_id?: string;

DeepgramSpeechFullApiSchemaGrantV1Request

type DeepgramSpeechFullApiSchemaGrantV1Request = {
  ttl_seconds?: number;
};

Properties

ttl_seconds?
optional ttl_seconds?: number;

DeepgramSpeechFullApiSchemaGrantV1Response

type DeepgramSpeechFullApiSchemaGrantV1Response = {
  access_token: string;
  expires_in?: number;
};

Properties

access_token
access_token: string;
expires_in?
optional expires_in?: number;

DeepgramSpeechFullApiSchemaJsonPrimitive

type DeepgramSpeechFullApiSchemaJsonPrimitive = string | number | boolean | null;

DeepgramSpeechFullApiSchemaJsonValue

type DeepgramSpeechFullApiSchemaJsonValue =
  | DeepgramSpeechFullApiSchemaJsonPrimitive
  | readonly DeepgramSpeechFullApiSchemaJsonValue[]
  | {
[key: string]: DeepgramSpeechFullApiSchemaJsonValue;
};

DeepgramSpeechFullApiSchemaLeaveProjectV1Response

type DeepgramSpeechFullApiSchemaLeaveProjectV1Response = {
  message?: string;
};

Properties

message?
optional message?: string;

DeepgramSpeechFullApiSchemaListAgentConfigurationsV1Response

type DeepgramSpeechFullApiSchemaListAgentConfigurationsV1Response = {
  agents?: ReadonlyArray<DeepgramSpeechFullApiSchemaAgentConfigurationV1>;
};

Properties

agents?
optional agents?: ReadonlyArray<DeepgramSpeechFullApiSchemaAgentConfigurationV1>;

DeepgramSpeechFullApiSchemaListAgentVariablesV1Response

type DeepgramSpeechFullApiSchemaListAgentVariablesV1Response = {
  variables?: ReadonlyArray<DeepgramSpeechFullApiSchemaAgentVariableV1>;
};

Properties

variables?
optional variables?: ReadonlyArray<DeepgramSpeechFullApiSchemaAgentVariableV1>;

DeepgramSpeechFullApiSchemaListBillingFieldsV1Response

type DeepgramSpeechFullApiSchemaListBillingFieldsV1Response = {
  accessors?: ReadonlyArray<string>;
  deployments?: ReadonlyArray<DeepgramSpeechFullApiSchemaListBillingFieldsV1ResponseDeploymentsItems>;
  line_items?: {
   [key: string]: string;
  };
  tags?: ReadonlyArray<string>;
};

Properties

accessors?
optional accessors?: ReadonlyArray<string>;
deployments?
optional deployments?: ReadonlyArray<DeepgramSpeechFullApiSchemaListBillingFieldsV1ResponseDeploymentsItems>;
line_items?
optional line_items?: {
[key: string]: string;
};
Index Signature
[key: string]: string
tags?
optional tags?: ReadonlyArray<string>;

DeepgramSpeechFullApiSchemaListBillingFieldsV1ResponseDeploymentsItems

type DeepgramSpeechFullApiSchemaListBillingFieldsV1ResponseDeploymentsItems = "hosted" | "beta" | "self-hosted" | "dedicated";

DeepgramSpeechFullApiSchemaListenV1AcceptedResponse

type DeepgramSpeechFullApiSchemaListenV1AcceptedResponse = {
  request_id: string;
};

Properties

request_id
request_id: string;

DeepgramSpeechFullApiSchemaListenV1MediaTranscribeResponse200

type DeepgramSpeechFullApiSchemaListenV1MediaTranscribeResponse200 =
  | DeepgramSpeechFullApiSchemaListenV1Response
  | DeepgramSpeechFullApiSchemaListenV1AcceptedResponse;

DeepgramSpeechFullApiSchemaListenV1RequestUrl

type DeepgramSpeechFullApiSchemaListenV1RequestUrl = {
  url: string;
};

Properties

url
url: string;

DeepgramSpeechFullApiSchemaListenV1Response

type DeepgramSpeechFullApiSchemaListenV1Response = {
  metadata: DeepgramSpeechFullApiSchemaListenV1ResponseMetadata;
  results: DeepgramSpeechFullApiSchemaListenV1ResponseResults;
};

Properties

metadata
metadata: DeepgramSpeechFullApiSchemaListenV1ResponseMetadata;
results
results: DeepgramSpeechFullApiSchemaListenV1ResponseResults;

DeepgramSpeechFullApiSchemaListenV1ResponseMetadata

type DeepgramSpeechFullApiSchemaListenV1ResponseMetadata = {
  channels: number;
  created: string;
  duration: number;
  intents_info?: DeepgramSpeechFullApiSchemaListenV1ResponseMetadataIntentsInfo;
  model_info: DeepgramSpeechFullApiSchemaListenV1ResponseMetadataModelInfo;
  models: ReadonlyArray<string>;
  request_id: string;
  sentiment_info?: DeepgramSpeechFullApiSchemaListenV1ResponseMetadataSentimentInfo;
  sha256: string;
  summary_info?: DeepgramSpeechFullApiSchemaListenV1ResponseMetadataSummaryInfo;
  tags?: ReadonlyArray<string>;
  topics_info?: DeepgramSpeechFullApiSchemaListenV1ResponseMetadataTopicsInfo;
  transaction_key?: string;
};

Properties

channels
channels: number;
created
created: string;
duration
duration: number;
intents_info?
optional intents_info?: DeepgramSpeechFullApiSchemaListenV1ResponseMetadataIntentsInfo;
model_info
model_info: DeepgramSpeechFullApiSchemaListenV1ResponseMetadataModelInfo;
models
models: ReadonlyArray<string>;
request_id
request_id: string;
sentiment_info?
optional sentiment_info?: DeepgramSpeechFullApiSchemaListenV1ResponseMetadataSentimentInfo;
sha256
sha256: string;
summary_info?
optional summary_info?: DeepgramSpeechFullApiSchemaListenV1ResponseMetadataSummaryInfo;
tags?
optional tags?: ReadonlyArray<string>;
topics_info?
optional topics_info?: DeepgramSpeechFullApiSchemaListenV1ResponseMetadataTopicsInfo;
transaction_key?
optional transaction_key?: string;

DeepgramSpeechFullApiSchemaListenV1ResponseMetadataIntentsInfo

type DeepgramSpeechFullApiSchemaListenV1ResponseMetadataIntentsInfo = {
  input_tokens?: number;
  model_uuid?: string;
  output_tokens?: number;
};

Properties

input_tokens?
optional input_tokens?: number;
model_uuid?
optional model_uuid?: string;
output_tokens?
optional output_tokens?: number;

DeepgramSpeechFullApiSchemaListenV1ResponseMetadataModelInfo

type DeepgramSpeechFullApiSchemaListenV1ResponseMetadataModelInfo = {
};

DeepgramSpeechFullApiSchemaListenV1ResponseMetadataSentimentInfo

type DeepgramSpeechFullApiSchemaListenV1ResponseMetadataSentimentInfo = {
  input_tokens?: number;
  model_uuid?: string;
  output_tokens?: number;
};

Properties

input_tokens?
optional input_tokens?: number;
model_uuid?
optional model_uuid?: string;
output_tokens?
optional output_tokens?: number;

DeepgramSpeechFullApiSchemaListenV1ResponseMetadataSummaryInfo

type DeepgramSpeechFullApiSchemaListenV1ResponseMetadataSummaryInfo = {
  input_tokens?: number;
  model_uuid?: string;
  output_tokens?: number;
};

Properties

input_tokens?
optional input_tokens?: number;
model_uuid?
optional model_uuid?: string;
output_tokens?
optional output_tokens?: number;

DeepgramSpeechFullApiSchemaListenV1ResponseMetadataTopicsInfo

type DeepgramSpeechFullApiSchemaListenV1ResponseMetadataTopicsInfo = {
  input_tokens?: number;
  model_uuid?: string;
  output_tokens?: number;
};

Properties

input_tokens?
optional input_tokens?: number;
model_uuid?
optional model_uuid?: string;
output_tokens?
optional output_tokens?: number;

DeepgramSpeechFullApiSchemaListenV1ResponseResults

type DeepgramSpeechFullApiSchemaListenV1ResponseResults = {
  channels: DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannels;
  intents?: DeepgramSpeechFullApiSchemaSharedIntents;
  sentiments?: DeepgramSpeechFullApiSchemaSharedSentiments;
  summary?: DeepgramSpeechFullApiSchemaListenV1ResponseResultsSummary;
  topics?: DeepgramSpeechFullApiSchemaSharedTopics;
  utterances?: DeepgramSpeechFullApiSchemaListenV1ResponseResultsUtterances;
};

Properties

channels
channels: DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannels;
intents?
optional intents?: DeepgramSpeechFullApiSchemaSharedIntents;
sentiments?
optional sentiments?: DeepgramSpeechFullApiSchemaSharedSentiments;
summary?
optional summary?: DeepgramSpeechFullApiSchemaListenV1ResponseResultsSummary;
topics?
optional topics?: DeepgramSpeechFullApiSchemaSharedTopics;
utterances?
optional utterances?: DeepgramSpeechFullApiSchemaListenV1ResponseResultsUtterances;

DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannels

type DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannels = ReadonlyArray<DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItems>;

DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItems

type DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItems = {
  alternatives?: ReadonlyArray<DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItems>;
  detected_language?: string;
  search?: ReadonlyArray<DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsSearchItems>;
};

Properties

alternatives?
optional alternatives?: ReadonlyArray<DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItems>;
detected_language?
optional detected_language?: string;
search?
optional search?: ReadonlyArray<DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsSearchItems>;

DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItems

type DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItems = {
  confidence?: number;
  entities?: ReadonlyArray<DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItemsEntitiesItems>;
  paragraphs?: DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItemsParagraphs;
  summaries?: ReadonlyArray<DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItemsSummariesItems>;
  topics?: ReadonlyArray<DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItemsTopicsItems>;
  transcript?: string;
  words?: ReadonlyArray<DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItemsWordsItems>;
};

Properties

confidence?
optional confidence?: number;
entities?
optional entities?: ReadonlyArray<DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItemsEntitiesItems>;
paragraphs?
optional paragraphs?: DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItemsParagraphs;
summaries?
optional summaries?: ReadonlyArray<DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItemsSummariesItems>;
topics?
optional topics?: ReadonlyArray<DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItemsTopicsItems>;
transcript?
optional transcript?: string;
words?
optional words?: ReadonlyArray<DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItemsWordsItems>;

DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItemsEntitiesItems

type DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItemsEntitiesItems = {
  confidence?: number;
  end_word?: number;
  label?: string;
  raw_value?: string;
  start_word?: number;
  value?: string;
};

Properties

confidence?
optional confidence?: number;
end_word?
optional end_word?: number;
label?
optional label?: string;
raw_value?
optional raw_value?: string;
start_word?
optional start_word?: number;
value?
optional value?: string;

DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItemsParagraphs

type DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItemsParagraphs = {
  paragraphs?: ReadonlyArray<DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItemsParagraphsParagraphsItems>;
  transcript?: string;
};

Properties

paragraphs?
optional paragraphs?: ReadonlyArray<DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItemsParagraphsParagraphsItems>;
transcript?
optional transcript?: string;

DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItemsParagraphsParagraphsItems

type DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItemsParagraphsParagraphsItems = {
  end?: number;
  num_words?: number;
  sentences?: ReadonlyArray<DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItemsParagraphsParagraphsItemsSentencesItems>;
  speaker?: number;
  start?: number;
};

Properties

end?
optional end?: number;
num_words?
optional num_words?: number;
sentences?
optional sentences?: ReadonlyArray<DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItemsParagraphsParagraphsItemsSentencesItems>;
speaker?
optional speaker?: number;
start?
optional start?: number;

DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItemsParagraphsParagraphsItemsSentencesItems

type DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItemsParagraphsParagraphsItemsSentencesItems = {
  end?: number;
  start?: number;
  text?: string;
};

Properties

end?
optional end?: number;
start?
optional start?: number;
text?
optional text?: string;

DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItemsSummariesItems

type DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItemsSummariesItems = {
  end_word?: number;
  start_word?: number;
  summary?: string;
};

Properties

end_word?
optional end_word?: number;
start_word?
optional start_word?: number;
summary?
optional summary?: string;

DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItemsTopicsItems

type DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItemsTopicsItems = {
  end_word?: number;
  start_word?: number;
  text?: string;
  topics?: ReadonlyArray<string>;
};

Properties

end_word?
optional end_word?: number;
start_word?
optional start_word?: number;
text?
optional text?: string;
topics?
optional topics?: ReadonlyArray<string>;

DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItemsWordsItems

type DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsAlternativesItemsWordsItems = {
  confidence?: number;
  end?: number;
  start?: number;
  word?: string;
};

Properties

confidence?
optional confidence?: number;
end?
optional end?: number;
start?
optional start?: number;
word?
optional word?: string;

DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsSearchItems

type DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsSearchItems = {
  hits?: ReadonlyArray<DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsSearchItemsHitsItems>;
  query?: string;
};

Properties

hits?
optional hits?: ReadonlyArray<DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsSearchItemsHitsItems>;
query?
optional query?: string;

DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsSearchItemsHitsItems

type DeepgramSpeechFullApiSchemaListenV1ResponseResultsChannelsItemsSearchItemsHitsItems = {
  confidence?: number;
  end?: number;
  snippet?: string;
  start?: number;
};

Properties

confidence?
optional confidence?: number;
end?
optional end?: number;
snippet?
optional snippet?: string;
start?
optional start?: number;

DeepgramSpeechFullApiSchemaListenV1ResponseResultsSummary

type DeepgramSpeechFullApiSchemaListenV1ResponseResultsSummary = {
  result?: string;
  short?: string;
};

Properties

result?
optional result?: string;
short?
optional short?: string;

DeepgramSpeechFullApiSchemaListenV1ResponseResultsUtterances

type DeepgramSpeechFullApiSchemaListenV1ResponseResultsUtterances = ReadonlyArray<DeepgramSpeechFullApiSchemaListenV1ResponseResultsUtterancesItems>;

DeepgramSpeechFullApiSchemaListenV1ResponseResultsUtterancesItems

type DeepgramSpeechFullApiSchemaListenV1ResponseResultsUtterancesItems = {
  channel?: number;
  confidence?: number;
  end?: number;
  id?: string;
  speaker?: number;
  start?: number;
  transcript?: string;
  words?: ReadonlyArray<DeepgramSpeechFullApiSchemaListenV1ResponseResultsUtterancesItemsWordsItems>;
};

Properties

channel?
optional channel?: number;
confidence?
optional confidence?: number;
end?
optional end?: number;
id?
optional id?: string;
speaker?
optional speaker?: number;
start?
optional start?: number;
transcript?
optional transcript?: string;
words?
optional words?: ReadonlyArray<DeepgramSpeechFullApiSchemaListenV1ResponseResultsUtterancesItemsWordsItems>;

DeepgramSpeechFullApiSchemaListenV1ResponseResultsUtterancesItemsWordsItems

type DeepgramSpeechFullApiSchemaListenV1ResponseResultsUtterancesItemsWordsItems = {
  confidence?: number;
  end?: number;
  punctuated_word?: string;
  speaker?: number;
  speaker_confidence?: number;
  start?: number;
  word?: string;
};

Properties

confidence?
optional confidence?: number;
end?
optional end?: number;
punctuated_word?
optional punctuated_word?: string;
speaker?
optional speaker?: number;
speaker_confidence?
optional speaker_confidence?: number;
start?
optional start?: number;
word?
optional word?: string;

DeepgramSpeechFullApiSchemaListModelsV1Response

type DeepgramSpeechFullApiSchemaListModelsV1Response = {
  stt?: ReadonlyArray<DeepgramSpeechFullApiSchemaListModelsV1ResponseSttModels>;
  tts?: ReadonlyArray<DeepgramSpeechFullApiSchemaListModelsV1ResponseTtsModels>;
};

Properties

stt?
optional stt?: ReadonlyArray<DeepgramSpeechFullApiSchemaListModelsV1ResponseSttModels>;
tts?
optional tts?: ReadonlyArray<DeepgramSpeechFullApiSchemaListModelsV1ResponseTtsModels>;

DeepgramSpeechFullApiSchemaListModelsV1ResponseSttModels

type DeepgramSpeechFullApiSchemaListModelsV1ResponseSttModels = {
  architecture?: string;
  batch?: boolean;
  canonical_name?: string;
  formatted_output?: boolean;
  languages?: ReadonlyArray<string>;
  name?: string;
  streaming?: boolean;
  uuid?: string;
  version?: string;
};

Properties

architecture?
optional architecture?: string;
batch?
optional batch?: boolean;
canonical_name?
optional canonical_name?: string;
formatted_output?
optional formatted_output?: boolean;
languages?
optional languages?: ReadonlyArray<string>;
name?
optional name?: string;
streaming?
optional streaming?: boolean;
uuid?
optional uuid?: string;
version?
optional version?: string;

DeepgramSpeechFullApiSchemaListModelsV1ResponseTtsModels

type DeepgramSpeechFullApiSchemaListModelsV1ResponseTtsModels = {
  architecture?: string;
  canonical_name?: string;
  languages?: ReadonlyArray<string>;
  metadata?: DeepgramSpeechFullApiSchemaListModelsV1ResponseTtsModelsMetadata;
  name?: string;
  uuid?: string;
  version?: string;
};

Properties

architecture?
optional architecture?: string;
canonical_name?
optional canonical_name?: string;
languages?
optional languages?: ReadonlyArray<string>;
metadata?
optional metadata?: DeepgramSpeechFullApiSchemaListModelsV1ResponseTtsModelsMetadata;
name?
optional name?: string;
uuid?
optional uuid?: string;
version?
optional version?: string;

DeepgramSpeechFullApiSchemaListModelsV1ResponseTtsModelsMetadata

type DeepgramSpeechFullApiSchemaListModelsV1ResponseTtsModelsMetadata = {
  accent?: string;
  age?: string;
  color?: string;
  image?: string;
  sample?: string;
  tags?: ReadonlyArray<string>;
  use_cases?: ReadonlyArray<string>;
};

Properties

accent?
optional accent?: string;
age?
optional age?: string;
color?
optional color?: string;
image?
optional image?: string;
sample?
optional sample?: string;
tags?
optional tags?: ReadonlyArray<string>;
use_cases?
optional use_cases?: ReadonlyArray<string>;

DeepgramSpeechFullApiSchemaListProjectBalancesV1Response

type DeepgramSpeechFullApiSchemaListProjectBalancesV1Response = {
  balances?: ReadonlyArray<DeepgramSpeechFullApiSchemaListProjectBalancesV1ResponseBalancesItems>;
};

Properties

balances?
optional balances?: ReadonlyArray<DeepgramSpeechFullApiSchemaListProjectBalancesV1ResponseBalancesItems>;

DeepgramSpeechFullApiSchemaListProjectBalancesV1ResponseBalancesItems

type DeepgramSpeechFullApiSchemaListProjectBalancesV1ResponseBalancesItems = {
  amount?: number;
  balance_id?: string;
  purchase_order_id?: string;
  units?: string;
};

Properties

amount?
optional amount?: number;
balance_id?
optional balance_id?: string;
purchase_order_id?
optional purchase_order_id?: string;
units?
optional units?: string;

DeepgramSpeechFullApiSchemaListProjectDistributionCredentialsV1Response

type DeepgramSpeechFullApiSchemaListProjectDistributionCredentialsV1Response = {
  distribution_credentials?: ReadonlyArray<DeepgramSpeechFullApiSchemaListProjectDistributionCredentialsV1ResponseDistributionCredentialsItems>;
};

Properties

distribution_credentials?
optional distribution_credentials?: ReadonlyArray<DeepgramSpeechFullApiSchemaListProjectDistributionCredentialsV1ResponseDistributionCredentialsItems>;

DeepgramSpeechFullApiSchemaListProjectDistributionCredentialsV1ResponseDistributionCredentialsItems

type DeepgramSpeechFullApiSchemaListProjectDistributionCredentialsV1ResponseDistributionCredentialsItems = {
  distribution_credentials: DeepgramSpeechFullApiSchemaListProjectDistributionCredentialsV1ResponseDistributionCredentialsItemsDistributionCredentials;
  member: DeepgramSpeechFullApiSchemaListProjectDistributionCredentialsV1ResponseDistributionCredentialsItemsMember;
};

Properties

distribution_credentials
distribution_credentials: DeepgramSpeechFullApiSchemaListProjectDistributionCredentialsV1ResponseDistributionCredentialsItemsDistributionCredentials;
member
member: DeepgramSpeechFullApiSchemaListProjectDistributionCredentialsV1ResponseDistributionCredentialsItemsMember;

DeepgramSpeechFullApiSchemaListProjectDistributionCredentialsV1ResponseDistributionCredentialsItemsDistributionCredentials

type DeepgramSpeechFullApiSchemaListProjectDistributionCredentialsV1ResponseDistributionCredentialsItemsDistributionCredentials = {
  comment?: string;
  created: string;
  distribution_credentials_id: string;
  provider: string;
  scopes: ReadonlyArray<string>;
};

Properties

comment?
optional comment?: string;
created
created: string;
distribution_credentials_id
distribution_credentials_id: string;
provider
provider: string;
scopes
scopes: ReadonlyArray<string>;

DeepgramSpeechFullApiSchemaListProjectDistributionCredentialsV1ResponseDistributionCredentialsItemsMember

type DeepgramSpeechFullApiSchemaListProjectDistributionCredentialsV1ResponseDistributionCredentialsItemsMember = {
  email: string;
  member_id: string;
};

Properties

email
email: string;
member_id
member_id: string;

DeepgramSpeechFullApiSchemaListProjectInvitesV1Response

type DeepgramSpeechFullApiSchemaListProjectInvitesV1Response = {
  invites?: ReadonlyArray<DeepgramSpeechFullApiSchemaListProjectInvitesV1ResponseInvitesItems>;
};

Properties

invites?
optional invites?: ReadonlyArray<DeepgramSpeechFullApiSchemaListProjectInvitesV1ResponseInvitesItems>;

DeepgramSpeechFullApiSchemaListProjectInvitesV1ResponseInvitesItems

type DeepgramSpeechFullApiSchemaListProjectInvitesV1ResponseInvitesItems = {
  email?: string;
  scope?: string;
};

Properties

email?
optional email?: string;
scope?
optional scope?: string;

DeepgramSpeechFullApiSchemaListProjectKeysV1Response

type DeepgramSpeechFullApiSchemaListProjectKeysV1Response = {
  api_keys?: ReadonlyArray<DeepgramSpeechFullApiSchemaListProjectKeysV1ResponseApiKeysItems>;
};

Properties

api_keys?
optional api_keys?: ReadonlyArray<DeepgramSpeechFullApiSchemaListProjectKeysV1ResponseApiKeysItems>;

DeepgramSpeechFullApiSchemaListProjectKeysV1ResponseApiKeysItems

type DeepgramSpeechFullApiSchemaListProjectKeysV1ResponseApiKeysItems = {
  api_key?: DeepgramSpeechFullApiSchemaListProjectKeysV1ResponseApiKeysItemsApiKey;
  member?: DeepgramSpeechFullApiSchemaListProjectKeysV1ResponseApiKeysItemsMember;
};

Properties

api_key?
optional api_key?: DeepgramSpeechFullApiSchemaListProjectKeysV1ResponseApiKeysItemsApiKey;
member?
optional member?: DeepgramSpeechFullApiSchemaListProjectKeysV1ResponseApiKeysItemsMember;

DeepgramSpeechFullApiSchemaListProjectKeysV1ResponseApiKeysItemsApiKey

type DeepgramSpeechFullApiSchemaListProjectKeysV1ResponseApiKeysItemsApiKey = {
  api_key_id?: string;
  comment?: string;
  created?: string;
  scopes?: ReadonlyArray<string>;
};

Properties

api_key_id?
optional api_key_id?: string;
comment?
optional comment?: string;
created?
optional created?: string;
scopes?
optional scopes?: ReadonlyArray<string>;

DeepgramSpeechFullApiSchemaListProjectKeysV1ResponseApiKeysItemsMember

type DeepgramSpeechFullApiSchemaListProjectKeysV1ResponseApiKeysItemsMember = {
  email?: string;
  member_id?: string;
};

Properties

email?
optional email?: string;
member_id?
optional member_id?: string;

DeepgramSpeechFullApiSchemaListProjectMemberScopesV1Response

type DeepgramSpeechFullApiSchemaListProjectMemberScopesV1Response = {
  scopes?: ReadonlyArray<string>;
};

Properties

scopes?
optional scopes?: ReadonlyArray<string>;

DeepgramSpeechFullApiSchemaListProjectMembersV1Response

type DeepgramSpeechFullApiSchemaListProjectMembersV1Response = {
  members?: ReadonlyArray<DeepgramSpeechFullApiSchemaListProjectMembersV1ResponseMembersItems>;
};

Properties

members?
optional members?: ReadonlyArray<DeepgramSpeechFullApiSchemaListProjectMembersV1ResponseMembersItems>;

DeepgramSpeechFullApiSchemaListProjectMembersV1ResponseMembersItems

type DeepgramSpeechFullApiSchemaListProjectMembersV1ResponseMembersItems = {
  email?: string;
  first_name?: string;
  last_name?: string;
  member_id?: string;
  scopes?: ReadonlyArray<string>;
};

Properties

email?
optional email?: string;
first_name?
optional first_name?: string;
last_name?
optional last_name?: string;
member_id?
optional member_id?: string;
scopes?
optional scopes?: ReadonlyArray<string>;

DeepgramSpeechFullApiSchemaListProjectPurchasesV1Response

type DeepgramSpeechFullApiSchemaListProjectPurchasesV1Response = {
  orders?: ReadonlyArray<DeepgramSpeechFullApiSchemaListProjectPurchasesV1ResponseOrdersItems>;
};

Properties

orders?
optional orders?: ReadonlyArray<DeepgramSpeechFullApiSchemaListProjectPurchasesV1ResponseOrdersItems>;

DeepgramSpeechFullApiSchemaListProjectPurchasesV1ResponseOrdersItems

type DeepgramSpeechFullApiSchemaListProjectPurchasesV1ResponseOrdersItems = {
  amount?: number;
  created?: string;
  expiration?: string;
  order_id?: string;
  order_type?: string;
  units?: string;
};

Properties

amount?
optional amount?: number;
created?
optional created?: string;
expiration?
optional expiration?: string;
order_id?
optional order_id?: string;
order_type?
optional order_type?: string;
units?
optional units?: string;

DeepgramSpeechFullApiSchemaListProjectRequestsV1Response

type DeepgramSpeechFullApiSchemaListProjectRequestsV1Response = {
  limit?: number;
  page?: number;
  requests?: ReadonlyArray<DeepgramSpeechFullApiSchemaProjectRequestResponse>;
};

Properties

limit?
optional limit?: number;
page?
optional page?: number;
requests?
optional requests?: ReadonlyArray<DeepgramSpeechFullApiSchemaProjectRequestResponse>;

DeepgramSpeechFullApiSchemaListProjectsV1Response

type DeepgramSpeechFullApiSchemaListProjectsV1Response = {
  projects?: ReadonlyArray<DeepgramSpeechFullApiSchemaListProjectsV1ResponseProjectsItems>;
};

Properties

projects?
optional projects?: ReadonlyArray<DeepgramSpeechFullApiSchemaListProjectsV1ResponseProjectsItems>;

DeepgramSpeechFullApiSchemaListProjectsV1ResponseProjectsItems

type DeepgramSpeechFullApiSchemaListProjectsV1ResponseProjectsItems = {
  name?: string;
  project_id?: string;
};

Properties

name?
optional name?: string;
project_id?
optional project_id?: string;

DeepgramSpeechFullApiSchemaProjectRequestResponse

type DeepgramSpeechFullApiSchemaProjectRequestResponse = {
  api_key_id?: string;
  callback?: string;
  code?: number;
  created?: string;
  deployment?: string;
  path?: string;
  project_uuid?: string;
  request_id?: string;
  response?: DeepgramSpeechFullApiSchemaProjectRequestResponseResponse;
};

Properties

api_key_id?
optional api_key_id?: string;
callback?
optional callback?: string;
code?
optional code?: number;
created?
optional created?: string;
deployment?
optional deployment?: string;
path?
optional path?: string;
project_uuid?
optional project_uuid?: string;
request_id?
optional request_id?: string;
response?
optional response?: DeepgramSpeechFullApiSchemaProjectRequestResponseResponse;

DeepgramSpeechFullApiSchemaProjectRequestResponseResponse

type DeepgramSpeechFullApiSchemaProjectRequestResponseResponse = {
};

DeepgramSpeechFullApiSchemaReadV1Request

type DeepgramSpeechFullApiSchemaReadV1Request =
  | DeepgramSpeechFullApiSchemaReadV1RequestUrl
  | DeepgramSpeechFullApiSchemaReadV1RequestText;

DeepgramSpeechFullApiSchemaReadV1RequestText

type DeepgramSpeechFullApiSchemaReadV1RequestText = {
  text: string;
};

Properties

text
text: string;

DeepgramSpeechFullApiSchemaReadV1RequestUrl

type DeepgramSpeechFullApiSchemaReadV1RequestUrl = {
  url: string;
};

Properties

url
url: string;

DeepgramSpeechFullApiSchemaReadV1Response

type DeepgramSpeechFullApiSchemaReadV1Response = {
  metadata: DeepgramSpeechFullApiSchemaReadV1ResponseMetadata;
  results: DeepgramSpeechFullApiSchemaReadV1ResponseResults;
};

Properties

metadata
metadata: DeepgramSpeechFullApiSchemaReadV1ResponseMetadata;
results
results: DeepgramSpeechFullApiSchemaReadV1ResponseResults;

DeepgramSpeechFullApiSchemaReadV1ResponseMetadata

type DeepgramSpeechFullApiSchemaReadV1ResponseMetadata = {
  metadata?: DeepgramSpeechFullApiSchemaReadV1ResponseMetadataMetadata;
};

Properties

metadata?
optional metadata?: DeepgramSpeechFullApiSchemaReadV1ResponseMetadataMetadata;

DeepgramSpeechFullApiSchemaReadV1ResponseMetadataMetadata

type DeepgramSpeechFullApiSchemaReadV1ResponseMetadataMetadata = {
  created?: string;
  intents_info?: DeepgramSpeechFullApiSchemaReadV1ResponseMetadataMetadataIntentsInfo;
  language?: string;
  request_id?: string;
  sentiment_info?: DeepgramSpeechFullApiSchemaReadV1ResponseMetadataMetadataSentimentInfo;
  summary_info?: DeepgramSpeechFullApiSchemaReadV1ResponseMetadataMetadataSummaryInfo;
  topics_info?: DeepgramSpeechFullApiSchemaReadV1ResponseMetadataMetadataTopicsInfo;
};

Properties

created?
optional created?: string;
intents_info?
optional intents_info?: DeepgramSpeechFullApiSchemaReadV1ResponseMetadataMetadataIntentsInfo;
language?
optional language?: string;
request_id?
optional request_id?: string;
sentiment_info?
optional sentiment_info?: DeepgramSpeechFullApiSchemaReadV1ResponseMetadataMetadataSentimentInfo;
summary_info?
optional summary_info?: DeepgramSpeechFullApiSchemaReadV1ResponseMetadataMetadataSummaryInfo;
topics_info?
optional topics_info?: DeepgramSpeechFullApiSchemaReadV1ResponseMetadataMetadataTopicsInfo;

DeepgramSpeechFullApiSchemaReadV1ResponseMetadataMetadataIntentsInfo

type DeepgramSpeechFullApiSchemaReadV1ResponseMetadataMetadataIntentsInfo = {
  input_tokens?: number;
  model_uuid?: string;
  output_tokens?: number;
};

Properties

input_tokens?
optional input_tokens?: number;
model_uuid?
optional model_uuid?: string;
output_tokens?
optional output_tokens?: number;

DeepgramSpeechFullApiSchemaReadV1ResponseMetadataMetadataSentimentInfo

type DeepgramSpeechFullApiSchemaReadV1ResponseMetadataMetadataSentimentInfo = {
  input_tokens?: number;
  model_uuid?: string;
  output_tokens?: number;
};

Properties

input_tokens?
optional input_tokens?: number;
model_uuid?
optional model_uuid?: string;
output_tokens?
optional output_tokens?: number;

DeepgramSpeechFullApiSchemaReadV1ResponseMetadataMetadataSummaryInfo

type DeepgramSpeechFullApiSchemaReadV1ResponseMetadataMetadataSummaryInfo = {
  input_tokens?: number;
  model_uuid?: string;
  output_tokens?: number;
};

Properties

input_tokens?
optional input_tokens?: number;
model_uuid?
optional model_uuid?: string;
output_tokens?
optional output_tokens?: number;

DeepgramSpeechFullApiSchemaReadV1ResponseMetadataMetadataTopicsInfo

type DeepgramSpeechFullApiSchemaReadV1ResponseMetadataMetadataTopicsInfo = {
  input_tokens?: number;
  model_uuid?: string;
  output_tokens?: number;
};

Properties

input_tokens?
optional input_tokens?: number;
model_uuid?
optional model_uuid?: string;
output_tokens?
optional output_tokens?: number;

DeepgramSpeechFullApiSchemaReadV1ResponseResults

type DeepgramSpeechFullApiSchemaReadV1ResponseResults = {
  intents?: DeepgramSpeechFullApiSchemaSharedIntents;
  sentiments?: DeepgramSpeechFullApiSchemaSharedSentiments;
  summary?: DeepgramSpeechFullApiSchemaReadV1ResponseResultsSummary;
  topics?: DeepgramSpeechFullApiSchemaSharedTopics;
};

Properties

intents?
optional intents?: DeepgramSpeechFullApiSchemaSharedIntents;
sentiments?
optional sentiments?: DeepgramSpeechFullApiSchemaSharedSentiments;
summary?
optional summary?: DeepgramSpeechFullApiSchemaReadV1ResponseResultsSummary;
topics?
optional topics?: DeepgramSpeechFullApiSchemaSharedTopics;

DeepgramSpeechFullApiSchemaReadV1ResponseResultsSummary

type DeepgramSpeechFullApiSchemaReadV1ResponseResultsSummary = {
  results?: DeepgramSpeechFullApiSchemaReadV1ResponseResultsSummaryResults;
};

Properties

results?
optional results?: DeepgramSpeechFullApiSchemaReadV1ResponseResultsSummaryResults;

DeepgramSpeechFullApiSchemaReadV1ResponseResultsSummaryResults

type DeepgramSpeechFullApiSchemaReadV1ResponseResultsSummaryResults = {
  summary?: DeepgramSpeechFullApiSchemaReadV1ResponseResultsSummaryResultsSummary;
};

Properties

summary?
optional summary?: DeepgramSpeechFullApiSchemaReadV1ResponseResultsSummaryResultsSummary;

DeepgramSpeechFullApiSchemaReadV1ResponseResultsSummaryResultsSummary

type DeepgramSpeechFullApiSchemaReadV1ResponseResultsSummaryResultsSummary = {
  text?: string;
};

Properties

text?
optional text?: string;

DeepgramSpeechFullApiSchemaSharedIntents

type DeepgramSpeechFullApiSchemaSharedIntents = {
  results?: DeepgramSpeechFullApiSchemaSharedIntentsResults;
};

Properties

results?
optional results?: DeepgramSpeechFullApiSchemaSharedIntentsResults;

DeepgramSpeechFullApiSchemaSharedIntentsResults

type DeepgramSpeechFullApiSchemaSharedIntentsResults = {
  intents?: DeepgramSpeechFullApiSchemaSharedIntentsResultsIntents;
};

Properties

intents?
optional intents?: DeepgramSpeechFullApiSchemaSharedIntentsResultsIntents;

DeepgramSpeechFullApiSchemaSharedIntentsResultsIntents

type DeepgramSpeechFullApiSchemaSharedIntentsResultsIntents = {
  segments?: ReadonlyArray<DeepgramSpeechFullApiSchemaSharedIntentsResultsIntentsSegmentsItems>;
};

Properties

segments?
optional segments?: ReadonlyArray<DeepgramSpeechFullApiSchemaSharedIntentsResultsIntentsSegmentsItems>;

DeepgramSpeechFullApiSchemaSharedIntentsResultsIntentsSegmentsItems

type DeepgramSpeechFullApiSchemaSharedIntentsResultsIntentsSegmentsItems = {
  end_word?: number;
  intents?: ReadonlyArray<DeepgramSpeechFullApiSchemaSharedIntentsResultsIntentsSegmentsItemsIntentsItems>;
  start_word?: number;
  text?: string;
};

Properties

end_word?
optional end_word?: number;
intents?
optional intents?: ReadonlyArray<DeepgramSpeechFullApiSchemaSharedIntentsResultsIntentsSegmentsItemsIntentsItems>;
start_word?
optional start_word?: number;
text?
optional text?: string;

DeepgramSpeechFullApiSchemaSharedIntentsResultsIntentsSegmentsItemsIntentsItems

type DeepgramSpeechFullApiSchemaSharedIntentsResultsIntentsSegmentsItemsIntentsItems = {
  confidence_score?: number;
  intent?: string;
};

Properties

confidence_score?
optional confidence_score?: number;
intent?
optional intent?: string;

DeepgramSpeechFullApiSchemaSharedSentiments

type DeepgramSpeechFullApiSchemaSharedSentiments = {
  average?: DeepgramSpeechFullApiSchemaSharedSentimentsAverage;
  segments?: ReadonlyArray<DeepgramSpeechFullApiSchemaSharedSentimentsSegmentsItems>;
};

Properties

average?
optional average?: DeepgramSpeechFullApiSchemaSharedSentimentsAverage;
segments?
optional segments?: ReadonlyArray<DeepgramSpeechFullApiSchemaSharedSentimentsSegmentsItems>;

DeepgramSpeechFullApiSchemaSharedSentimentsAverage

type DeepgramSpeechFullApiSchemaSharedSentimentsAverage = {
  sentiment?: string;
  sentiment_score?: number;
};

Properties

sentiment?
optional sentiment?: string;
sentiment_score?
optional sentiment_score?: number;

DeepgramSpeechFullApiSchemaSharedSentimentsSegmentsItems

type DeepgramSpeechFullApiSchemaSharedSentimentsSegmentsItems = {
  end_word?: number;
  sentiment?: string;
  sentiment_score?: number;
  start_word?: number;
  text?: string;
};

Properties

end_word?
optional end_word?: number;
sentiment?
optional sentiment?: string;
sentiment_score?
optional sentiment_score?: number;
start_word?
optional start_word?: number;
text?
optional text?: string;

DeepgramSpeechFullApiSchemaSharedTopics

type DeepgramSpeechFullApiSchemaSharedTopics = {
  results?: DeepgramSpeechFullApiSchemaSharedTopicsResults;
};

Properties

results?
optional results?: DeepgramSpeechFullApiSchemaSharedTopicsResults;

DeepgramSpeechFullApiSchemaSharedTopicsResults

type DeepgramSpeechFullApiSchemaSharedTopicsResults = {
  topics?: DeepgramSpeechFullApiSchemaSharedTopicsResultsTopics;
};

Properties

topics?
optional topics?: DeepgramSpeechFullApiSchemaSharedTopicsResultsTopics;

DeepgramSpeechFullApiSchemaSharedTopicsResultsTopics

type DeepgramSpeechFullApiSchemaSharedTopicsResultsTopics = {
  segments?: ReadonlyArray<DeepgramSpeechFullApiSchemaSharedTopicsResultsTopicsSegmentsItems>;
};

Properties

segments?
optional segments?: ReadonlyArray<DeepgramSpeechFullApiSchemaSharedTopicsResultsTopicsSegmentsItems>;

DeepgramSpeechFullApiSchemaSharedTopicsResultsTopicsSegmentsItems

type DeepgramSpeechFullApiSchemaSharedTopicsResultsTopicsSegmentsItems = {
  end_word?: number;
  start_word?: number;
  text?: string;
  topics?: ReadonlyArray<DeepgramSpeechFullApiSchemaSharedTopicsResultsTopicsSegmentsItemsTopicsItems>;
};

Properties

end_word?
optional end_word?: number;
start_word?
optional start_word?: number;
text?
optional text?: string;
topics?
optional topics?: ReadonlyArray<DeepgramSpeechFullApiSchemaSharedTopicsResultsTopicsSegmentsItemsTopicsItems>;

DeepgramSpeechFullApiSchemaSharedTopicsResultsTopicsSegmentsItemsTopicsItems

type DeepgramSpeechFullApiSchemaSharedTopicsResultsTopicsSegmentsItemsTopicsItems = {
  confidence_score?: number;
  topic?: string;
};

Properties

confidence_score?
optional confidence_score?: number;
topic?
optional topic?: string;

DeepgramSpeechFullApiSchemaSpeakV1AudioGenerateResponse200

type DeepgramSpeechFullApiSchemaSpeakV1AudioGenerateResponse200 = {
};

DeepgramSpeechFullApiSchemaSpeakV1Request

type DeepgramSpeechFullApiSchemaSpeakV1Request = {
  text: string;
};

Properties

text
text: string;

DeepgramSpeechFullApiSchemaUpdateAgentMetadataV1Request

type DeepgramSpeechFullApiSchemaUpdateAgentMetadataV1Request = {
  metadata: {
   [key: string]: string;
  };
};

Properties

metadata
metadata: {
[key: string]: string;
};
Index Signature
[key: string]: string

DeepgramSpeechFullApiSchemaUpdateAgentVariableV1Request

type DeepgramSpeechFullApiSchemaUpdateAgentVariableV1Request = {
  value: DeepgramSpeechFullApiSchemaJsonValue;
};

Properties

value
value: DeepgramSpeechFullApiSchemaJsonValue;

DeepgramSpeechFullApiSchemaUpdateProjectMemberScopesV1Request

type DeepgramSpeechFullApiSchemaUpdateProjectMemberScopesV1Request = {
  scope: string;
};

Properties

scope
scope: string;

DeepgramSpeechFullApiSchemaUpdateProjectMemberScopesV1Response

type DeepgramSpeechFullApiSchemaUpdateProjectMemberScopesV1Response = {
  message?: string;
};

Properties

message?
optional message?: string;

DeepgramSpeechFullApiSchemaUpdateProjectV1Request

type DeepgramSpeechFullApiSchemaUpdateProjectV1Request = {
  name?: string;
};

Properties

name?
optional name?: string;

DeepgramSpeechFullApiSchemaUpdateProjectV1Response

type DeepgramSpeechFullApiSchemaUpdateProjectV1Response = {
  message?: string;
};

Properties

message?
optional message?: string;

DeepgramSpeechFullApiSchemaUsageBreakdownV1Response

type DeepgramSpeechFullApiSchemaUsageBreakdownV1Response = {
  end: string;
  resolution: DeepgramSpeechFullApiSchemaUsageBreakdownV1ResponseResolution;
  results: ReadonlyArray<DeepgramSpeechFullApiSchemaUsageBreakdownV1ResponseResultsItems>;
  start: string;
};

Properties

end
end: string;
resolution
resolution: DeepgramSpeechFullApiSchemaUsageBreakdownV1ResponseResolution;
results
results: ReadonlyArray<DeepgramSpeechFullApiSchemaUsageBreakdownV1ResponseResultsItems>;
start
start: string;

DeepgramSpeechFullApiSchemaUsageBreakdownV1ResponseResolution

type DeepgramSpeechFullApiSchemaUsageBreakdownV1ResponseResolution = {
  amount: number;
  units: string;
};

Properties

amount
amount: number;
units
units: string;

DeepgramSpeechFullApiSchemaUsageBreakdownV1ResponseResultsItems

type DeepgramSpeechFullApiSchemaUsageBreakdownV1ResponseResultsItems = {
  agent_hours: number;
  grouping: DeepgramSpeechFullApiSchemaUsageBreakdownV1ResponseResultsItemsGrouping;
  hours: number;
  requests: number;
  tokens_in: number;
  tokens_out: number;
  total_hours: number;
  tts_characters: number;
};

Properties

agent_hours
agent_hours: number;
grouping
grouping: DeepgramSpeechFullApiSchemaUsageBreakdownV1ResponseResultsItemsGrouping;
hours
hours: number;
requests
requests: number;
tokens_in
tokens_in: number;
tokens_out
tokens_out: number;
total_hours
total_hours: number;
tts_characters
tts_characters: number;

DeepgramSpeechFullApiSchemaUsageBreakdownV1ResponseResultsItemsGrouping

type DeepgramSpeechFullApiSchemaUsageBreakdownV1ResponseResultsItemsGrouping = {
  accessor?: string | null;
  deployment?: string | null;
  end?: string;
  endpoint?: string | null;
  feature_set?: string | null;
  method?: string | null;
  models?: ReadonlyArray<string>;
  start?: string;
  tags?: ReadonlyArray<string> | null;
};

Properties

accessor?
optional accessor?: string | null;
deployment?
optional deployment?: string | null;
end?
optional end?: string;
endpoint?
optional endpoint?: string | null;
feature_set?
optional feature_set?: string | null;
method?
optional method?: string | null;
models?
optional models?: ReadonlyArray<string>;
start?
optional start?: string;
tags?
optional tags?: ReadonlyArray<string> | null;

DeepgramSpeechFullApiSchemaUsageFieldsV1Response

type DeepgramSpeechFullApiSchemaUsageFieldsV1Response = {
  features?: ReadonlyArray<string>;
  models?: ReadonlyArray<DeepgramSpeechFullApiSchemaUsageFieldsV1ResponseModelsItems>;
  processing_methods?: ReadonlyArray<string>;
  tags?: ReadonlyArray<string>;
};

Properties

features?
optional features?: ReadonlyArray<string>;
models?
optional models?: ReadonlyArray<DeepgramSpeechFullApiSchemaUsageFieldsV1ResponseModelsItems>;
processing_methods?
optional processing_methods?: ReadonlyArray<string>;
tags?
optional tags?: ReadonlyArray<string>;

DeepgramSpeechFullApiSchemaUsageFieldsV1ResponseModelsItems

type DeepgramSpeechFullApiSchemaUsageFieldsV1ResponseModelsItems = {
  language?: string;
  model_id?: string;
  name?: string;
  version?: string;
};

Properties

language?
optional language?: string;
model_id?
optional model_id?: string;
name?
optional name?: string;
version?
optional version?: string;

DeepgramSpeechFullApiSchemaUsageV1Response

type DeepgramSpeechFullApiSchemaUsageV1Response = {
  end?: string;
  resolution?: DeepgramSpeechFullApiSchemaUsageV1ResponseResolution;
  start?: string;
};

Properties

end?
optional end?: string;
resolution?
optional resolution?: DeepgramSpeechFullApiSchemaUsageV1ResponseResolution;
start?
optional start?: string;

DeepgramSpeechFullApiSchemaUsageV1ResponseResolution

type DeepgramSpeechFullApiSchemaUsageV1ResponseResolution = {
  amount?: number;
  units?: string;
};

Properties

amount?
optional amount?: number;
units?
optional units?: string;

DeepgramSpeechFullApiSchemaV1ListenPostParametersCallbackMethod

type DeepgramSpeechFullApiSchemaV1ListenPostParametersCallbackMethod = "POST" | "PUT";

DeepgramSpeechFullApiSchemaV1ListenPostParametersCustomIntent

type DeepgramSpeechFullApiSchemaV1ListenPostParametersCustomIntent = string | ReadonlyArray<string>;

DeepgramSpeechFullApiSchemaV1ListenPostParametersCustomIntentMode

type DeepgramSpeechFullApiSchemaV1ListenPostParametersCustomIntentMode = "extended" | "strict";

DeepgramSpeechFullApiSchemaV1ListenPostParametersCustomTopic

type DeepgramSpeechFullApiSchemaV1ListenPostParametersCustomTopic = string | ReadonlyArray<string>;

DeepgramSpeechFullApiSchemaV1ListenPostParametersCustomTopicMode

type DeepgramSpeechFullApiSchemaV1ListenPostParametersCustomTopicMode = "extended" | "strict";

DeepgramSpeechFullApiSchemaV1ListenPostParametersDetectLanguage

type DeepgramSpeechFullApiSchemaV1ListenPostParametersDetectLanguage = boolean | ReadonlyArray<string>;

DeepgramSpeechFullApiSchemaV1ListenPostParametersDiarizeModel

type DeepgramSpeechFullApiSchemaV1ListenPostParametersDiarizeModel = "latest" | "v1" | "v2";

DeepgramSpeechFullApiSchemaV1ListenPostParametersEncoding

type DeepgramSpeechFullApiSchemaV1ListenPostParametersEncoding =
  | "linear16"
  | "flac"
  | "mulaw"
  | "amr-nb"
  | "amr-wb"
  | "opus"
  | "speex"
  | "g729";

DeepgramSpeechFullApiSchemaV1ListenPostParametersExtra

type DeepgramSpeechFullApiSchemaV1ListenPostParametersExtra = string | ReadonlyArray<string>;

DeepgramSpeechFullApiSchemaV1ListenPostParametersKeywords

type DeepgramSpeechFullApiSchemaV1ListenPostParametersKeywords = string | ReadonlyArray<string>;

DeepgramSpeechFullApiSchemaV1ListenPostParametersModel

type DeepgramSpeechFullApiSchemaV1ListenPostParametersModel =
  | DeepgramSpeechFullApiSchemaV1ListenPostParametersModel0
  | string;

DeepgramSpeechFullApiSchemaV1ListenPostParametersModel0

type DeepgramSpeechFullApiSchemaV1ListenPostParametersModel0 =
  | "nova-3"
  | "nova-3-general"
  | "nova-3-medical"
  | "nova-2"
  | "nova-2-general"
  | "nova-2-meeting"
  | "nova-2-finance"
  | "nova-2-conversationalai"
  | "nova-2-voicemail"
  | "nova-2-video"
  | "nova-2-medical"
  | "nova-2-drivethru"
  | "nova-2-automotive"
  | "nova"
  | "nova-general"
  | "nova-phonecall"
  | "nova-medical"
  | "enhanced"
  | "enhanced-general"
  | "enhanced-meeting"
  | "enhanced-phonecall"
  | "enhanced-finance"
  | "base"
  | "meeting"
  | "phonecall"
  | "finance"
  | "conversationalai"
  | "voicemail"
  | "video";

DeepgramSpeechFullApiSchemaV1ListenPostParametersRedact

type DeepgramSpeechFullApiSchemaV1ListenPostParametersRedact =
  | string
  | DeepgramSpeechFullApiSchemaV1ListenPostParametersRedact1;

DeepgramSpeechFullApiSchemaV1ListenPostParametersRedact1

type DeepgramSpeechFullApiSchemaV1ListenPostParametersRedact1 = ReadonlyArray<DeepgramSpeechFullApiSchemaV1ListenPostParametersRedactSchemaOneOf1Items>;

DeepgramSpeechFullApiSchemaV1ListenPostParametersRedactSchemaOneOf1Items

type DeepgramSpeechFullApiSchemaV1ListenPostParametersRedactSchemaOneOf1Items = "pci" | "pii" | "numbers";

DeepgramSpeechFullApiSchemaV1ListenPostParametersReplace

type DeepgramSpeechFullApiSchemaV1ListenPostParametersReplace = string | ReadonlyArray<string>;

DeepgramSpeechFullApiSchemaV1ListenPostParametersSearch

type DeepgramSpeechFullApiSchemaV1ListenPostParametersSearch = string | ReadonlyArray<string>;

DeepgramSpeechFullApiSchemaV1ListenPostParametersSummarize

type DeepgramSpeechFullApiSchemaV1ListenPostParametersSummarize =
  | DeepgramSpeechFullApiSchemaV1ListenPostParametersSummarize0
  | boolean;

DeepgramSpeechFullApiSchemaV1ListenPostParametersSummarize0

type DeepgramSpeechFullApiSchemaV1ListenPostParametersSummarize0 = "v2";

DeepgramSpeechFullApiSchemaV1ListenPostParametersTag

type DeepgramSpeechFullApiSchemaV1ListenPostParametersTag = string | ReadonlyArray<string>;

DeepgramSpeechFullApiSchemaV1ListenPostParametersVersion

type DeepgramSpeechFullApiSchemaV1ListenPostParametersVersion =
  | DeepgramSpeechFullApiSchemaV1ListenPostParametersVersion0
  | string;

DeepgramSpeechFullApiSchemaV1ListenPostParametersVersion0

type DeepgramSpeechFullApiSchemaV1ListenPostParametersVersion0 = "latest";

DeepgramSpeechFullApiSchemaV1ProjectsProjectIdBillingBreakdownGetParametersDeployment

type DeepgramSpeechFullApiSchemaV1ProjectsProjectIdBillingBreakdownGetParametersDeployment = "hosted" | "beta" | "self-hosted";

DeepgramSpeechFullApiSchemaV1ProjectsProjectIdBillingBreakdownGetParametersGroupingSchemaItems

type DeepgramSpeechFullApiSchemaV1ProjectsProjectIdBillingBreakdownGetParametersGroupingSchemaItems = "accessor" | "deployment" | "line_item" | "tags";

DeepgramSpeechFullApiSchemaV1ProjectsProjectIdKeysGetParametersStatus

type DeepgramSpeechFullApiSchemaV1ProjectsProjectIdKeysGetParametersStatus = "active" | "expired";

DeepgramSpeechFullApiSchemaV1ProjectsProjectIdRequestsGetParametersDeployment

type DeepgramSpeechFullApiSchemaV1ProjectsProjectIdRequestsGetParametersDeployment = "hosted" | "beta" | "self-hosted";

DeepgramSpeechFullApiSchemaV1ProjectsProjectIdRequestsGetParametersEndpoint

type DeepgramSpeechFullApiSchemaV1ProjectsProjectIdRequestsGetParametersEndpoint = "listen" | "read" | "speak" | "agent";

DeepgramSpeechFullApiSchemaV1ProjectsProjectIdRequestsGetParametersMethod

type DeepgramSpeechFullApiSchemaV1ProjectsProjectIdRequestsGetParametersMethod = "sync" | "async" | "streaming";

DeepgramSpeechFullApiSchemaV1ProjectsProjectIdRequestsGetParametersStatus

type DeepgramSpeechFullApiSchemaV1ProjectsProjectIdRequestsGetParametersStatus = "succeeded" | "failed";

DeepgramSpeechFullApiSchemaV1ProjectsProjectIdSelfHostedDistributionCredentialsPostParametersProvider

type DeepgramSpeechFullApiSchemaV1ProjectsProjectIdSelfHostedDistributionCredentialsPostParametersProvider = "quay";

DeepgramSpeechFullApiSchemaV1ProjectsProjectIdSelfHostedDistributionCredentialsPostParametersScopesSchemaItems

type DeepgramSpeechFullApiSchemaV1ProjectsProjectIdSelfHostedDistributionCredentialsPostParametersScopesSchemaItems =
  | "self-hosted:products"
  | "self-hosted:product:api"
  | "self-hosted:product:engine"
  | "self-hosted:product:license-proxy"
  | "self-hosted:product:dgtools"
  | "self-hosted:product:billing"
  | "self-hosted:product:hotpepper"
  | "self-hosted:product:metrics-server";

DeepgramSpeechFullApiSchemaV1ProjectsProjectIdUsageBreakdownGetParametersDeployment

type DeepgramSpeechFullApiSchemaV1ProjectsProjectIdUsageBreakdownGetParametersDeployment = "hosted" | "beta" | "self-hosted";

DeepgramSpeechFullApiSchemaV1ProjectsProjectIdUsageBreakdownGetParametersEndpoint

type DeepgramSpeechFullApiSchemaV1ProjectsProjectIdUsageBreakdownGetParametersEndpoint = "listen" | "read" | "speak" | "agent";

DeepgramSpeechFullApiSchemaV1ProjectsProjectIdUsageBreakdownGetParametersGrouping

type DeepgramSpeechFullApiSchemaV1ProjectsProjectIdUsageBreakdownGetParametersGrouping =
  | "accessor"
  | "endpoint"
  | "feature_set"
  | "models"
  | "method"
  | "tags"
  | "deployment";

DeepgramSpeechFullApiSchemaV1ProjectsProjectIdUsageBreakdownGetParametersMethod

type DeepgramSpeechFullApiSchemaV1ProjectsProjectIdUsageBreakdownGetParametersMethod = "sync" | "async" | "streaming";

DeepgramSpeechFullApiSchemaV1ProjectsProjectIdUsageGetParametersDeployment

type DeepgramSpeechFullApiSchemaV1ProjectsProjectIdUsageGetParametersDeployment = "hosted" | "beta" | "self-hosted";

DeepgramSpeechFullApiSchemaV1ProjectsProjectIdUsageGetParametersEndpoint

type DeepgramSpeechFullApiSchemaV1ProjectsProjectIdUsageGetParametersEndpoint = "listen" | "read" | "speak" | "agent";

DeepgramSpeechFullApiSchemaV1ProjectsProjectIdUsageGetParametersMethod

type DeepgramSpeechFullApiSchemaV1ProjectsProjectIdUsageGetParametersMethod = "sync" | "async" | "streaming";

DeepgramSpeechFullApiSchemaV1ReadPostParametersCallbackMethod

type DeepgramSpeechFullApiSchemaV1ReadPostParametersCallbackMethod = "POST" | "PUT";

DeepgramSpeechFullApiSchemaV1ReadPostParametersCustomIntent

type DeepgramSpeechFullApiSchemaV1ReadPostParametersCustomIntent = string | ReadonlyArray<string>;

DeepgramSpeechFullApiSchemaV1ReadPostParametersCustomIntentMode

type DeepgramSpeechFullApiSchemaV1ReadPostParametersCustomIntentMode = "extended" | "strict";

DeepgramSpeechFullApiSchemaV1ReadPostParametersCustomTopic

type DeepgramSpeechFullApiSchemaV1ReadPostParametersCustomTopic = string | ReadonlyArray<string>;

DeepgramSpeechFullApiSchemaV1ReadPostParametersCustomTopicMode

type DeepgramSpeechFullApiSchemaV1ReadPostParametersCustomTopicMode = "extended" | "strict";

DeepgramSpeechFullApiSchemaV1ReadPostParametersSummarize

type DeepgramSpeechFullApiSchemaV1ReadPostParametersSummarize =
  | DeepgramSpeechFullApiSchemaV1ReadPostParametersSummarize0
  | boolean;

DeepgramSpeechFullApiSchemaV1ReadPostParametersSummarize0

type DeepgramSpeechFullApiSchemaV1ReadPostParametersSummarize0 = "v2";

DeepgramSpeechFullApiSchemaV1ReadPostParametersTag

type DeepgramSpeechFullApiSchemaV1ReadPostParametersTag = string | ReadonlyArray<string>;

DeepgramSpeechFullApiSchemaV1SpeakPostParametersBitRate

type DeepgramSpeechFullApiSchemaV1SpeakPostParametersBitRate =
  | DeepgramSpeechFullApiSchemaV1SpeakPostParametersBitRate0
  | number
  | number;

DeepgramSpeechFullApiSchemaV1SpeakPostParametersBitRate0

type DeepgramSpeechFullApiSchemaV1SpeakPostParametersBitRate0 = "32000" | "48000";

DeepgramSpeechFullApiSchemaV1SpeakPostParametersCallbackMethod

type DeepgramSpeechFullApiSchemaV1SpeakPostParametersCallbackMethod = "POST" | "PUT";

DeepgramSpeechFullApiSchemaV1SpeakPostParametersContainer

type DeepgramSpeechFullApiSchemaV1SpeakPostParametersContainer =
  | DeepgramSpeechFullApiSchemaV1SpeakPostParametersContainer0
  | DeepgramSpeechFullApiSchemaV1SpeakPostParametersContainer1
  | DeepgramSpeechFullApiSchemaV1SpeakPostParametersContainer2
  | DeepgramSpeechFullApiSchemaV1SpeakPostParametersContainer3
  | DeepgramSpeechFullApiSchemaV1SpeakPostParametersContainer4;

DeepgramSpeechFullApiSchemaV1SpeakPostParametersContainer0

type DeepgramSpeechFullApiSchemaV1SpeakPostParametersContainer0 = "none";

DeepgramSpeechFullApiSchemaV1SpeakPostParametersContainer1

type DeepgramSpeechFullApiSchemaV1SpeakPostParametersContainer1 = "wav";

DeepgramSpeechFullApiSchemaV1SpeakPostParametersContainer2

type DeepgramSpeechFullApiSchemaV1SpeakPostParametersContainer2 = "wav";

DeepgramSpeechFullApiSchemaV1SpeakPostParametersContainer3

type DeepgramSpeechFullApiSchemaV1SpeakPostParametersContainer3 = "wav";

DeepgramSpeechFullApiSchemaV1SpeakPostParametersContainer4

type DeepgramSpeechFullApiSchemaV1SpeakPostParametersContainer4 = "ogg";

DeepgramSpeechFullApiSchemaV1SpeakPostParametersEncoding

type DeepgramSpeechFullApiSchemaV1SpeakPostParametersEncoding =
  | DeepgramSpeechFullApiSchemaV1SpeakPostParametersEncoding0
  | DeepgramSpeechFullApiSchemaV1SpeakPostParametersEncoding1
  | DeepgramSpeechFullApiSchemaV1SpeakPostParametersEncoding2
  | DeepgramSpeechFullApiSchemaV1SpeakPostParametersEncoding3
  | DeepgramSpeechFullApiSchemaV1SpeakPostParametersEncoding4
  | DeepgramSpeechFullApiSchemaV1SpeakPostParametersEncoding5
  | DeepgramSpeechFullApiSchemaV1SpeakPostParametersEncoding6;

DeepgramSpeechFullApiSchemaV1SpeakPostParametersEncoding0

type DeepgramSpeechFullApiSchemaV1SpeakPostParametersEncoding0 = "linear16";

DeepgramSpeechFullApiSchemaV1SpeakPostParametersEncoding1

type DeepgramSpeechFullApiSchemaV1SpeakPostParametersEncoding1 = "flac";

DeepgramSpeechFullApiSchemaV1SpeakPostParametersEncoding2

type DeepgramSpeechFullApiSchemaV1SpeakPostParametersEncoding2 = "mulaw";

DeepgramSpeechFullApiSchemaV1SpeakPostParametersEncoding3

type DeepgramSpeechFullApiSchemaV1SpeakPostParametersEncoding3 = "alaw";

DeepgramSpeechFullApiSchemaV1SpeakPostParametersEncoding4

type DeepgramSpeechFullApiSchemaV1SpeakPostParametersEncoding4 = "mp3";

DeepgramSpeechFullApiSchemaV1SpeakPostParametersEncoding5

type DeepgramSpeechFullApiSchemaV1SpeakPostParametersEncoding5 = "opus";

DeepgramSpeechFullApiSchemaV1SpeakPostParametersEncoding6

type DeepgramSpeechFullApiSchemaV1SpeakPostParametersEncoding6 = "aac";

DeepgramSpeechFullApiSchemaV1SpeakPostParametersModel

type DeepgramSpeechFullApiSchemaV1SpeakPostParametersModel =
  | "aura-asteria-en"
  | "aura-luna-en"
  | "aura-stella-en"
  | "aura-athena-en"
  | "aura-hera-en"
  | "aura-orion-en"
  | "aura-arcas-en"
  | "aura-perseus-en"
  | "aura-angus-en"
  | "aura-orpheus-en"
  | "aura-helios-en"
  | "aura-zeus-en"
  | "aura-2-amalthea-en"
  | "aura-2-andromeda-en"
  | "aura-2-apollo-en"
  | "aura-2-arcas-en"
  | "aura-2-aries-en"
  | "aura-2-asteria-en"
  | "aura-2-athena-en"
  | "aura-2-atlas-en"
  | "aura-2-aurora-en"
  | "aura-2-callista-en"
  | "aura-2-cordelia-en"
  | "aura-2-cora-en"
  | "aura-2-delia-en"
  | "aura-2-draco-en"
  | "aura-2-electra-en"
  | "aura-2-harmonia-en"
  | "aura-2-helena-en"
  | "aura-2-hera-en"
  | "aura-2-hermes-en"
  | "aura-2-hyperion-en"
  | "aura-2-iris-en"
  | "aura-2-janus-en"
  | "aura-2-juno-en"
  | "aura-2-jupiter-en"
  | "aura-2-luna-en"
  | "aura-2-mars-en"
  | "aura-2-minerva-en"
  | "aura-2-neptune-en"
  | "aura-2-odysseus-en"
  | "aura-2-ophelia-en"
  | "aura-2-orion-en"
  | "aura-2-orpheus-en"
  | "aura-2-pandora-en"
  | "aura-2-phoebe-en"
  | "aura-2-pluto-en"
  | "aura-2-saturn-en"
  | "aura-2-selene-en"
  | "aura-2-thalia-en"
  | "aura-2-theia-en"
  | "aura-2-vesta-en"
  | "aura-2-zeus-en"
  | "aura-2-sirio-es"
  | "aura-2-nestor-es"
  | "aura-2-carina-es"
  | "aura-2-celeste-es"
  | "aura-2-alvaro-es"
  | "aura-2-diana-es"
  | "aura-2-aquila-es"
  | "aura-2-selena-es"
  | "aura-2-estrella-es"
  | "aura-2-javier-es";

DeepgramSpeechFullApiSchemaV1SpeakPostParametersSampleRate

type DeepgramSpeechFullApiSchemaV1SpeakPostParametersSampleRate =
  | DeepgramSpeechFullApiSchemaV1SpeakPostParametersSampleRate0
  | DeepgramSpeechFullApiSchemaV1SpeakPostParametersSampleRate1
  | DeepgramSpeechFullApiSchemaV1SpeakPostParametersSampleRate2
  | DeepgramSpeechFullApiSchemaV1SpeakPostParametersSampleRate3
  | DeepgramSpeechFullApiSchemaV1SpeakPostParametersSampleRate4;

DeepgramSpeechFullApiSchemaV1SpeakPostParametersSampleRate0

type DeepgramSpeechFullApiSchemaV1SpeakPostParametersSampleRate0 = "8000" | "16000" | "24000" | "32000" | "48000";

DeepgramSpeechFullApiSchemaV1SpeakPostParametersSampleRate1

type DeepgramSpeechFullApiSchemaV1SpeakPostParametersSampleRate1 = "8000" | "16000";

DeepgramSpeechFullApiSchemaV1SpeakPostParametersSampleRate2

type DeepgramSpeechFullApiSchemaV1SpeakPostParametersSampleRate2 = "8000" | "16000";

DeepgramSpeechFullApiSchemaV1SpeakPostParametersSampleRate3

type DeepgramSpeechFullApiSchemaV1SpeakPostParametersSampleRate3 = "22050";

DeepgramSpeechFullApiSchemaV1SpeakPostParametersSampleRate4

type DeepgramSpeechFullApiSchemaV1SpeakPostParametersSampleRate4 = "48000";

DeepgramSpeechFullApiSchemaV1SpeakPostParametersTag

type DeepgramSpeechFullApiSchemaV1SpeakPostParametersTag = string | ReadonlyArray<string>;

DeepgramSpeechGeneratedOperationCaller

type DeepgramSpeechGeneratedOperationCaller = <OperationKey>(operationKey, ...args) => Promise<DeepgramSpeechFullApiOperationResponseMap[OperationKey]>;

Type Parameters

Type Parameter
OperationKey extends DeepgramSpeechFullApiOperationKey

Parameters

Parameter Type
operationKey OperationKey
...args DeepgramSpeechFullApiOperationArgs\<OperationKey>

Returns

Promise\<DeepgramSpeechFullApiOperationResponseMap[OperationKey]>


DeepgramSpeechJsonPrimitive

type DeepgramSpeechJsonPrimitive = string | number | boolean | null;

DeepgramSpeechJsonValue

type DeepgramSpeechJsonValue =
  | DeepgramSpeechJsonPrimitive
  | DeepgramSpeechJsonObject
  | DeepgramSpeechJsonValue[];

DeepgramSpeechResource

type DeepgramSpeechResource =
  | DeepgramSpeechJsonValue
  | ArrayBuffer
| ReadableStream<Uint8Array>;

Variables

DEEPGRAM_SPEECH_FULL_API_GENERATED_AT

const DEEPGRAM_SPEECH_FULL_API_GENERATED_AT: "2026-06-18";

DEEPGRAM_SPEECH_FULL_API_GENERATED_FUNCTION_COUNT

const DEEPGRAM_SPEECH_FULL_API_GENERATED_FUNCTION_COUNT: 49;

DEEPGRAM_SPEECH_FULL_API_GENERATED_FUNCTION_NAMES

const DEEPGRAM_SPEECH_FULL_API_GENERATED_FUNCTION_NAMES: readonly ["List", "Grant", "Transcribe", "Get5", "List6", "Delete3", "Get3", "Leave", "List4", "Update3", "Get10", "List13", "List14", "List15", "List16", "Create3", "Delete4", "Get6", "List7", "Delete5", "List8", "Create4", "Delete6", "List10", "List9", "Update4", "Get4", "List5", "Get7", "List11", "Get8", "Get9", "List12", "Analyze", "Create5", "Delete7", "Get11", "List17", "Generate", "Create", "Delete", "Get", "List2", "Update", "Create2", "Delete2", "Get2", "List3", "Update2"];

DEEPGRAM_SPEECH_FULL_API_OPERATION_BY_ID

const DEEPGRAM_SPEECH_FULL_API_OPERATION_BY_ID: Map<string, DeepgramSpeechFullApiOperation>;

DEEPGRAM_SPEECH_FULL_API_OPERATION_BY_OPERATION_ID

const DEEPGRAM_SPEECH_FULL_API_OPERATION_BY_OPERATION_ID: Map<string, DeepgramSpeechFullApiOperation>;

DEEPGRAM_SPEECH_FULL_API_OPERATION_COUNT

const DEEPGRAM_SPEECH_FULL_API_OPERATION_COUNT: 49;

DEEPGRAM_SPEECH_FULL_API_OPERATIONS

const DEEPGRAM_SPEECH_FULL_API_OPERATIONS: readonly DeepgramSpeechFullApiOperation[];

DEEPGRAM_SPEECH_FULL_API_SPEC

const DEEPGRAM_SPEECH_FULL_API_SPEC: {
  docsUrl: string;
  openapi: string;
  operationCount: number;
  pathCount: number;
  sourceUrl: string;
  title: string;
  version: string;
};

Type Declaration

Name Type
docsUrl string
openapi string
operationCount number
pathCount number
sourceUrl string
title string
version string

DEEPGRAM_SPEECH_FULL_API_SPEC_SOURCE

const DEEPGRAM_SPEECH_FULL_API_SPEC_SOURCE: "https://developers.deepgram.com/openapi.json";

DEEPGRAM_SPEECH_FULL_API_SPEC_VERSION

const DEEPGRAM_SPEECH_FULL_API_SPEC_VERSION: "deepgram-1.0.0";

deepgramSpeechProviderManifest

const deepgramSpeechProviderManifest: {
  capabilities: {
     audiences?: ("customer-facing" | "internal-support" | "mixed")[];
     capability: string;
     changesWorkflow?: boolean;
     description?: string;
     exposesSensitiveData?: boolean;
     extension?: boolean;
     label?: string;
     metadata?: Record<string, unknown>;
     providerObjects?: {
        description?: string;
        kind: string;
        label?: string;
        metadata?: Record<string, unknown>;
        schemaName?: string;
     }[];
     requiresCredential?: boolean;
     sideEffect?: boolean;
  }[];
  category: string;
  channelAudiences: ("customer-facing" | "internal-support" | "mixed")[];
  coverage: {
     evidence: {
        label: string;
        url?: string;
     }[];
     notes: string[];
     scope:   | "support-workflow-subset"
        | "provider-api-subset"
        | "connector-required"
        | "local-protocol"
        | "full-provider-api";
  };
  credentialRequirements: {
     description?: string;
     id: string;
     label?: string;
     metadata?: Record<string, unknown>;
     required: boolean;
     scopes: string[];
  }[];
  directions: (
     | "receive-only"
     | "send-only"
     | "inbound-only"
     | "outbound-only"
    | "bidirectional")[];
  id: string;
  limitations: string[];
  maintainers: {
     name: string;
     type: "community" | "official" | "unknown" | "partner";
     url?: string;
  }[];
  metadata?: Record<string, unknown>;
  name: string;
  operations: {
     alias: string;
     audience?: "customer-facing" | "internal-support" | "mixed";
     audiences?: ("customer-facing" | "internal-support" | "mixed")[];
     capability: string;
     changesWorkflow?: boolean;
     description?: string;
     exposesSensitiveData?: boolean;
     extension: boolean;
     externallyVisible?: boolean;
     inputSchema?: unknown;
     inputSchemaName?: string;
     inputSchemaRef?: string;
     label?: string;
     metadata?: Record<string, unknown>;
     outputSchema?: unknown;
     outputSchemaName?: string;
     outputSchemaRef?: string;
     providerObject?: string;
     providerObjects?: {
        description?: string;
        kind: string;
        label?: string;
        metadata?: Record<string, unknown>;
        schemaName?: string;
     }[];
     providerOperation?: string;
     requiredPolicyIds?: string[];
     requiresApproval?: boolean;
     requiresCredential?: boolean;
     sideEffect?: boolean;
  }[];
  packageName: string;
  privacyNotes: string[];
  provider: string;
  trustLevel: "community" | "official" | "verified" | "experimental";
};

Type Declaration

Name Type
capabilities { audiences?: ("customer-facing" | "internal-support" | "mixed")[]; capability: string; changesWorkflow?: boolean; description?: string; exposesSensitiveData?: boolean; extension?: boolean; label?: string; metadata?: Record\<string, unknown>; providerObjects?: { description?: string; kind: string; label?: string; metadata?: Record\<string, unknown>; schemaName?: string; }[]; requiresCredential?: boolean; sideEffect?: boolean; }[]
category string
channelAudiences ("customer-facing" | "internal-support" | "mixed")[]
coverage { evidence: { label: string; url?: string; }[]; notes: string[]; scope: | "support-workflow-subset" | "provider-api-subset" | "connector-required" | "local-protocol" | "full-provider-api"; }
coverage.evidence { label: string; url?: string; }[]
coverage.notes string[]
coverage.scope | "support-workflow-subset" | "provider-api-subset" | "connector-required" | "local-protocol" | "full-provider-api"
credentialRequirements { description?: string; id: string; label?: string; metadata?: Record\<string, unknown>; required: boolean; scopes: string[]; }[]
directions ( | "receive-only" | "send-only" | "inbound-only" | "outbound-only" | "bidirectional")[]
id string
limitations string[]
maintainers { name: string; type: "community" | "official" | "unknown" | "partner"; url?: string; }[]
metadata? Record\<string, unknown>
name string
operations { alias: string; audience?: "customer-facing" | "internal-support" | "mixed"; audiences?: ("customer-facing" | "internal-support" | "mixed")[]; capability: string; changesWorkflow?: boolean; description?: string; exposesSensitiveData?: boolean; extension: boolean; externallyVisible?: boolean; inputSchema?: unknown; inputSchemaName?: string; inputSchemaRef?: string; label?: string; metadata?: Record\<string, unknown>; outputSchema?: unknown; outputSchemaName?: string; outputSchemaRef?: string; providerObject?: string; providerObjects?: { description?: string; kind: string; label?: string; metadata?: Record\<string, unknown>; schemaName?: string; }[]; providerOperation?: string; requiredPolicyIds?: string[]; requiresApproval?: boolean; requiresCredential?: boolean; sideEffect?: boolean; }[]
packageName string
privacyNotes string[]
provider string
trustLevel "community" | "official" | "verified" | "experimental"

Functions

createDeepgramSpeechClient()

function createDeepgramSpeechClient(options): DeepgramSpeechClient;

Parameters

Parameter Type
options DeepgramSpeechClientOptions

Returns

DeepgramSpeechClient


createDeepgramSpeechFullApiGeneratedClient()

function createDeepgramSpeechFullApiGeneratedClient(callOperation): DeepgramSpeechFullApiGeneratedClient;

Parameters

Parameter Type
callOperation DeepgramSpeechGeneratedOperationCaller

Returns

DeepgramSpeechFullApiGeneratedClient


createDeepgramSpeechVoiceProvider()

function createDeepgramSpeechVoiceProvider(options?): VoiceProvider;

Parameters

Parameter Type
options? DeepgramSpeechVoiceProviderOptions

Returns

VoiceProvider


deepgramSpeechCredentialStatuses()

function deepgramSpeechCredentialStatuses(input): {
  expiresAt?: string;
  message?: string;
  providerPackageId?: string;
  requirementId: string;
  scopes?: string[];
  state:   | "required"
     | "configured"
     | "permission-blocked"
     | "not-required"
     | "missing"
     | "expired"
     | "insufficient-scope"
     | "unavailable";
}[];

Parameters

Parameter Type
input DeepgramSpeechCredentialStatusInput

Returns

{ expiresAt?: string; message?: string; providerPackageId?: string; requirementId: string; scopes?: string[]; state: | "required" | "configured" | "permission-blocked" | "not-required" | "missing" | "expired" | "insufficient-scope" | "unavailable"; }[]