Skip to content

Commit 606154f

Browse files
deepgram-robotgithub-actions[bot]
deepgram-robot
and
github-actions[bot]
authored
feat: update API specifications (#64)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 8389976 commit 606154f

File tree

1 file changed

+145
-112
lines changed

1 file changed

+145
-112
lines changed

‎openapi.yml‎

Lines changed: 145 additions & 112 deletions
Original file line numberDiff line numberDiff line change
@@ -536,13 +536,7 @@ paths:
536536
description: Returns metadata for a specific model
537537
responses:
538538
'200':
539-
description: A specific model
540-
content:
541-
application/json:
542-
schema:
543-
oneOf:
544-
- $ref: '#/components/schemas/stt_models'
545-
- $ref: '#/components/schemas/tts_models'
539+
$ref: '#/components/responses/model'
546540
'400':
547541
$ref: '#/components/responses/projects_bad_request'
548542
/v1/auth/grant:
@@ -3142,44 +3136,59 @@ components:
31423136
example: zeus
31433137
canonical_name:
31443138
type: string
3145-
example: aura-zeus-en
3139+
example: aura-2-zeus-en
31463140
architecture:
31473141
type: string
3148-
example: aura
3142+
example: aura-2
31493143
languages:
31503144
type: array
31513145
items:
31523146
type: string
31533147
example:
31543148
- en
3155-
- en-us
3149+
- en-US
31563150
version:
31573151
type: string
3158-
example: 2024-07-30.0
3152+
example: 2025-04-07.0
31593153
uuid:
31603154
type: string
3161-
example: 9c28bce5-f144-4d32-9034-843aa7aed63e
3155+
format: uuid
3156+
example: 2baf189d-91ac-481d-b6d1-750888667b31
31623157
metadata:
31633158
type: object
31643159
properties:
31653160
accent:
31663161
type: string
31673162
example: American
3163+
age:
3164+
type: string
3165+
example: Adult
31683166
color:
31693167
type: string
3170-
example: '#949498'
3168+
example: '#C58DFF'
31713169
image:
31723170
type: string
3171+
format: uri
31733172
example: https://static.deepgram.com/examples/avatars/zeus.jpg
31743173
sample:
31753174
type: string
3176-
example: https://static.deepgram.com/examples/voices/zeus.wav
3175+
format: uri
3176+
example: https://static.deepgram.com/examples/Aura-2-zeus.wav
31773177
tags:
31783178
type: array
31793179
items:
31803180
type: string
31813181
example:
31823182
- masculine
3183+
- deep
3184+
- trustworthy
3185+
- smooth
3186+
use_cases:
3187+
type: array
3188+
items:
3189+
type: string
3190+
example:
3191+
- IVR
31833192
keys:
31843193
type: array
31853194
items:
@@ -3585,6 +3594,106 @@ components:
35853594
message: A project with the submitted ID cannot be found.
35863595
details: Check that you have submitted the intended project ID and that the project has not been deleted.
35873596
request_id: 123456-7890-1234-5678-901234
3597+
model:
3598+
description: A model object that can be either STT or TTS
3599+
content:
3600+
application/json:
3601+
schema:
3602+
oneOf:
3603+
- type: object
3604+
properties:
3605+
name:
3606+
type: string
3607+
example: general
3608+
canonical_name:
3609+
type: string
3610+
example: enhanced-general
3611+
architecture:
3612+
type: string
3613+
example: polaris
3614+
languages:
3615+
type: array
3616+
items:
3617+
type: string
3618+
example:
3619+
- en
3620+
- en-us
3621+
version:
3622+
type: string
3623+
example: 2022-05-18.1
3624+
uuid:
3625+
type: string
3626+
format: uuid
3627+
example: c7226e9e-ae1c-4057-ae2a-a71a6b0dc588
3628+
batch:
3629+
type: boolean
3630+
example: true
3631+
streaming:
3632+
type: boolean
3633+
example: true
3634+
formatted_output:
3635+
type: boolean
3636+
example: false
3637+
- type: object
3638+
properties:
3639+
name:
3640+
type: string
3641+
example: zeus
3642+
canonical_name:
3643+
type: string
3644+
example: aura-2-zeus-en
3645+
architecture:
3646+
type: string
3647+
example: aura-2
3648+
languages:
3649+
type: array
3650+
items:
3651+
type: string
3652+
example:
3653+
- en
3654+
- en-US
3655+
version:
3656+
type: string
3657+
example: 2025-04-07.0
3658+
uuid:
3659+
type: string
3660+
format: uuid
3661+
example: 2baf189d-91ac-481d-b6d1-750888667b31
3662+
metadata:
3663+
type: object
3664+
properties:
3665+
accent:
3666+
type: string
3667+
example: American
3668+
age:
3669+
type: string
3670+
example: Adult
3671+
color:
3672+
type: string
3673+
example: '#C58DFF'
3674+
image:
3675+
type: string
3676+
format: uri
3677+
example: https://static.deepgram.com/examples/avatars/zeus.jpg
3678+
sample:
3679+
type: string
3680+
format: uri
3681+
example: https://static.deepgram.com/examples/Aura-2-zeus.wav
3682+
tags:
3683+
type: array
3684+
items:
3685+
type: string
3686+
example:
3687+
- masculine
3688+
- deep
3689+
- trustworthy
3690+
- smooth
3691+
use_cases:
3692+
type: array
3693+
items:
3694+
type: string
3695+
example:
3696+
- IVR
35883697
jwt:
35893698
description: JWT token response
35903699
content:
@@ -3951,138 +4060,62 @@ components:
39514060
properties:
39524061
name:
39534062
type: string
3954-
example: angus
4063+
example: zeus
39554064
canonical_name:
39564065
type: string
3957-
example: aura-angus-en
4066+
example: aura-2-zeus-en
39584067
architecture:
39594068
type: string
3960-
example: aura
4069+
example: aura-2
39614070
languages:
39624071
type: array
39634072
items:
39644073
type: string
39654074
example:
39664075
- en
3967-
- en-us
4076+
- en-US
39684077
version:
39694078
type: string
3970-
example: 2024-07-30.0
4079+
example: 2025-04-07.0
39714080
uuid:
39724081
type: string
39734082
format: uuid
3974-
example: eed36e9e-37aa-40a3-91fa-a2911e73a5da
4083+
example: 2baf189d-91ac-481d-b6d1-750888667b31
39754084
metadata:
39764085
type: object
39774086
properties:
39784087
accent:
39794088
type: string
3980-
example: Irish
4089+
example: American
4090+
age:
4091+
type: string
4092+
example: Adult
39814093
color:
39824094
type: string
3983-
example: '#BA80F5'
4095+
example: '#C58DFF'
39844096
image:
39854097
type: string
39864098
format: uri
3987-
example: https://static.deepgram.com/examples/avatars/angus.jpg
4099+
example: https://static.deepgram.com/examples/avatars/zeus.jpg
39884100
sample:
39894101
type: string
39904102
format: uri
3991-
example: https://static.deepgram.com/examples/voices/angus.wav
4103+
example: https://static.deepgram.com/examples/Aura-2-zeus.wav
39924104
tags:
39934105
type: array
39944106
items:
39954107
type: string
39964108
example:
39974109
- masculine
3998-
model:
3999-
description: A model object that can be either STT or TTS
4000-
content:
4001-
application/json:
4002-
schema:
4003-
oneOf:
4004-
- type: object
4005-
properties:
4006-
name:
4007-
type: string
4008-
example: general
4009-
canonical_name:
4010-
type: string
4011-
example: enhanced-general
4012-
architecture:
4013-
type: string
4014-
example: polaris
4015-
languages:
4016-
type: array
4017-
items:
4018-
type: string
4019-
example:
4020-
- en
4021-
- en-us
4022-
version:
4023-
type: string
4024-
example: 2022-05-18.1
4025-
uuid:
4026-
type: string
4027-
format: uuid
4028-
example: c7226e9e-ae1c-4057-ae2a-a71a6b0dc588
4029-
batch:
4030-
type: boolean
4031-
example: true
4032-
streaming:
4033-
type: boolean
4034-
example: true
4035-
formatted_output:
4036-
type: boolean
4037-
example: false
4038-
- type: object
4039-
properties:
4040-
name:
4041-
type: string
4042-
example: angus
4043-
canonical_name:
4044-
type: string
4045-
example: aura-angus-en
4046-
architecture:
4047-
type: string
4048-
example: aura
4049-
languages:
4050-
type: array
4051-
items:
4052-
type: string
4053-
example:
4054-
- en
4055-
- en-us
4056-
version:
4057-
type: string
4058-
example: 2024-07-30.0
4059-
uuid:
4060-
type: string
4061-
format: uuid
4062-
example: eed36e9e-37aa-40a3-91fa-a2911e73a5da
4063-
metadata:
4064-
type: object
4065-
properties:
4066-
accent:
4067-
type: string
4068-
example: Irish
4069-
color:
4070-
type: string
4071-
example: '#BA80F5'
4072-
image:
4073-
type: string
4074-
format: uri
4075-
example: https://static.deepgram.com/examples/avatars/angus.jpg
4076-
sample:
4077-
type: string
4078-
format: uri
4079-
example: https://static.deepgram.com/examples/voices/angus.wav
4080-
tags:
4081-
type: array
4082-
items:
4083-
type: string
4084-
example:
4085-
- masculine
4110+
- deep
4111+
- trustworthy
4112+
- smooth
4113+
use_cases:
4114+
type: array
4115+
items:
4116+
type: string
4117+
example:
4118+
- IVR
40864119
credentials:
40874120
description: List of distribution credentials
40884121
content:

0 commit comments

Comments
 (0)