openapi.yml

openapi: 3.1.0
info:
  title: Deepgram API Specification
  version: 1.0.0
  description: |
    Deepgram's voice AI platform provides APIs for speech-to-text, text-to-speech, and language understanding. From medical transcription to autonomous agents, Deepgram is the go-to choice for developers of voice AI experiences.
    The Deepgram API allows you to interact with Deepgram programmatically.
    You can use our API to: - Transcribe speech to text. - Transform text to speech. - Analyze text. - Administer your Deepgram account.
  termsOfService: https://deepgram.com/terms/
  contact:
    email: devrel@deepgram.com
    url: https://community.deepgram.com
    name: Deepgram Developer Relations
  license:
    name: Privacy Notice
    url: https://deepgram.com/privacy/
servers:
  - url: https://api.deepgram.com
    description: Deepgram Production API
security:
  - ApiKeyAuth: []
tags:
  - name: Speech to Text
    description: Power your apps with world-class speech recognition
  - name: Audio Intelligence
    description: Analyze audio sources
  - name: Text Intelligence
    description: Analyze the content of text sources
  - name: Text to Speech
    description: Transform text to speech
  - name: Management API
    description: Manage your projects
externalDocs:
  description: Learn more about using Deepgram on our docs.
  url: http://developers.deepgram.com
paths:
  /v1/listen:
    description: Use Deepgram's speech-to-text API to transcribe and analyze pre-recorded audio
    post:
      summary: Transcribe and analyze pre-recorded audio
      tags:
        - Speech to Text
      security:
        - ApiKeyAuth: []
      description: Transcribe audio using Deepgram's speech-to-text API
      operationId: listen
      requestBody:
        description: Transcribe an audio file
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListenRequestUrl'
          audio/*:
            schema:
              $ref: '#/components/schemas/ListenRequestFile'
        required: true
      parameters:
        - $ref: '#/components/parameters/callback'
        - $ref: '#/components/parameters/callback_method'
        - $ref: '#/components/parameters/custom_topic'
        - $ref: '#/components/parameters/custom_topic_mode'
        - $ref: '#/components/parameters/custom_intent'
        - $ref: '#/components/parameters/custom_intent_mode'
        - $ref: '#/components/parameters/detect_entities'
        - $ref: '#/components/parameters/detect_language'
        - $ref: '#/components/parameters/diarize_version'
        - $ref: '#/components/parameters/diarize'
        - $ref: '#/components/parameters/dictation'
        - $ref: '#/components/parameters/encoding'
        - $ref: '#/components/parameters/extra'
        - $ref: '#/components/parameters/filler_words'
        - $ref: '#/components/parameters/intents'
        - $ref: '#/components/parameters/keyterm'
        - $ref: '#/components/parameters/keywords'
        - $ref: '#/components/parameters/language'
        - $ref: '#/components/parameters/measurements'
        - $ref: '#/components/parameters/model'
        - $ref: '#/components/parameters/multichannel'
        - $ref: '#/components/parameters/numerals'
        - $ref: '#/components/parameters/paragraphs'
        - $ref: '#/components/parameters/profanity_filter'
        - $ref: '#/components/parameters/punctuate'
        - $ref: '#/components/parameters/redact'
        - $ref: '#/components/parameters/replace'
        - $ref: '#/components/parameters/search'
        - $ref: '#/components/parameters/sentiment'
        - $ref: '#/components/parameters/smart_format'
        - $ref: '#/components/parameters/summarize'
        - $ref: '#/components/parameters/tag'
        - $ref: '#/components/parameters/topics'
        - $ref: '#/components/parameters/utterances'
        - $ref: '#/components/parameters/utt_split'
        - $ref: '#/components/parameters/version'
      responses:
        '200':
          description: Successful transcription
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '402':
          $ref: '#/components/responses/payment_required'
        '403':
          $ref: '#/components/responses/insufficient_permissions'
      callbacks:
        transcriptionCallback:
          '{$request.query.callback}':
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/response'
              responses:
                '200':
                  description: We expect a 200 to determine whether the callback was successfully received
  /v1/read:
    description: Use Deepgram's speech-to-text API to analyze the content of text sources
    post:
      summary: Analyze text content
      tags:
        - Text Intelligence
      security:
        - ApiKeyAuth: []
      operationId: TextRead
      description: Analyze text content using Deepgram's text analysis API
      requestBody:
        description: Analyze a text file
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/text_request'
      parameters:
        - $ref: '#/components/parameters/callback'
        - $ref: '#/components/parameters/callback_method'
        - $ref: '#/components/parameters/custom_topic'
        - $ref: '#/components/parameters/custom_topic_mode'
        - $ref: '#/components/parameters/intents'
        - $ref: '#/components/parameters/language'
        - $ref: '#/components/parameters/sentiment'
        - $ref: '#/components/parameters/summarize'
        - $ref: '#/components/parameters/topics'
      responses:
        '200':
          description: Successful text analysis
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/text_response'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
      callbacks:
        transcriptionCallback:
          '{$request.query.callback}':
            post:
              description: Callback endpoint for text analysis results
              requestBody:
                description: The text analysis results
                required: true
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/text_response'
              responses:
                '200':
                  description: We expect a 200 to determine whether the callback was successfully received
  /v1/speak:
    description: Use Deepgram's Aura text-to-speech API to transform text to speech
    post:
      summary: Text to Speech transformation
      tags:
        - Text to Speech
      security:
        - ApiKeyAuth: []
      description: Convert text into natural-sounding speech using Deepgram's TTS API
      operationId: speak
      requestBody:
        description: Transform text to speech
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/speak_request'
      parameters:
        - $ref: '#/components/parameters/bit_rate'
        - $ref: '#/components/parameters/callback'
        - $ref: '#/components/parameters/container'
        - $ref: '#/components/parameters/speak_encoding'
        - $ref: '#/components/parameters/speak_model'
        - $ref: '#/components/parameters/speak_sample_rate'
      responses:
        '200':
          description: Successful text to speech
          content:
            audio/mpeg:
              schema:
                type: string
                format: binary
            audio/wav:
              schema:
                type: string
                format: binary
            audio/l16;rate=24000:
              schema:
                type: string
                format: binary
            audio/ogg;codecs=opus:
              schema:
                type: string
                format: binary
            audio/flac:
              schema:
                type: string
                format: binary
            audio/acc:
              schema:
                type: string
                format: binary
            audio/mulaw;rate=8000:
              schema:
                type: string
                format: binary
            audio/alaw;rate=8000:
              schema:
                type: string
                format: binary
        '400':
          $ref: '#/components/responses/bad_request'
        '403':
          $ref: '#/components/responses/insufficient_permissions'
        '413':
          $ref: '#/components/responses/payload_too_large'
        '415':
          $ref: '#/components/responses/unsupported_media_type'
      callbacks:
        transcriptionCallback:
          '{$request.query.callback}':
            post:
              description: Callback endpoint for text-to-speech results
              requestBody:
                description: The text-to-speech processing results
                required: true
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/speak_response'
              responses:
                '200':
                  description: We expect a 200 to determine whether the callback was successfully received
  /v1/projects:
    description: Manage your projects
    get:
      summary: List Projects
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: listProjects
      description: Retrieves basic information about the projects associated with the API key
      responses:
        '200':
          description: A list of projects
          content:
            application/json:
              schema:
                type: object
                properties:
                  projects:
                    type: array
                    items:
                      type: object
                      properties:
                        project_id:
                          type: string
                          description: The unique identifier of the project
                        name:
                          type: string
                          description: The name of the project
        '403':
          $ref: '#/components/responses/authentication_failed'
  /v1/projects/{project_id}:
    description: Manage individual project details and settings
    parameters:
      - $ref: '#/components/parameters/project_id'
    get:
      summary: Get a Project
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: getProject
      description: Retrieves information about the specified project
      parameters:
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/start'
        - $ref: '#/components/parameters/end'
        - $ref: '#/components/parameters/page'
      responses:
        '200':
          description: A project
          content:
            application/json:
              schema:
                type: object
                properties:
                  project_id:
                    type: string
                    description: The unique identifier of the project
                  name:
                    type: string
                    description: The name of the project
        '400':
          $ref: '#/components/responses/projects_bad_request'
        '403':
          $ref: '#/components/responses/authentication_failed'
        '404':
          $ref: '#/components/responses/project_not_found'
    patch:
      summary: Update a Project
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: updateProject
      description: Updates the name or other properties of an existing project
      parameters:
        - $ref: '#/components/parameters/project_id'
      requestBody:
        description: The name of the project
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update_projects'
      responses:
        '200':
          description: A project
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: confirmation message
                example:
                  message: Successfully updated project info.
        '400':
          $ref: '#/components/responses/projects_bad_request'
        '403':
          $ref: '#/components/responses/authentication_failed'
        '404':
          $ref: '#/components/responses/project_not_found'
    delete:
      summary: Delete a Project
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: deleteProject
      description: Deletes the specified project
      parameters:
        - $ref: '#/components/parameters/project_id'
      responses:
        '200':
          description: A project
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: confirmation message
                example:
                  message: Successfully deleted a project.
        '400':
          $ref: '#/components/responses/projects_bad_request'
        '403':
          $ref: '#/components/responses/authentication_failed'
        '404':
          $ref: '#/components/responses/project_not_found'
  /v1/projects/{project_id}/balances:
    description: Manage your project balances
    get:
      summary: Get Project Balances
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: getProjectBalances
      description: Generates a list of outstanding balances for the specified project
      parameters:
        - $ref: '#/components/parameters/project_id'
      responses:
        '200':
          description: A list of outstanding balances
          content:
            application/json:
              schema:
                type: object
                properties:
                  balances:
                    type: array
                    items:
                      type: object
                      properties:
                        balance_id:
                          type: string
                          description: The unique identifier of the balance
                        amount:
                          type: integer
                          default: 0
                          description: The amount of the balance
                        units:
                          type: string
                          description: The units of the balance, such as "USD"
                        purchase_order_id:
                          type: string
                          description: Description or reference of the purchase
              example:
                balances:
                  - balance_id: b123456-7890-1234-5678-901234
                    amount: 250
                    units: usd
                    purchase_order_id: b123456-7890-1234-5678-901234
        '400':
          $ref: '#/components/responses/projects_bad_request'
        '403':
          $ref: '#/components/responses/authentication_failed'
        '404':
          $ref: '#/components/responses/project_not_found'
  /v1/projects/{project_id}/balances/{balance_id}:
    description: Manage your project balances
    get:
      summary: Get a Project Balance
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: getProjectBalance
      description: Retrieves details about the specified balance
      parameters:
        - $ref: '#/components/parameters/project_id'
        - $ref: '#/components/parameters/balance_id'
      responses:
        '200':
          description: A specific balance
          content:
            application/json:
              schema:
                type: object
                properties:
                  balance_id:
                    type: string
                    description: The unique identifier of the balance
                  amount:
                    type: integer
                    default: 0
                    description: The amount of the balance
                  units:
                    type: string
                    description: The units of the balance, such as "USD"
                  purchase_order_id:
                    type: string
                    description: Description or reference of the purchase
              example:
                balance_id: b123456-7890-1234-5678-901234
                amount: 250
                units: usd
                purchase_order_id: b123456-7890-1234-5678-901234
        '400':
          $ref: '#/components/responses/projects_bad_request'
        '403':
          $ref: '#/components/responses/authentication_failed'
        '404':
          $ref: '#/components/responses/project_not_found'
  /v1/projects/{project_id}/models:
    description: Manage your project models
    get:
      summary: Get All Project Models
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: listProjectModels
      description: Returns metadata on all the latest models that a specific project has access to, including non-public models
      parameters:
        - $ref: '#/components/parameters/project_id'
        - $ref: '#/components/parameters/include_outdated'
      responses:
        '200':
          description: A list of models
          content:
            application/json:
              schema:
                type: object
                properties:
                  stt:
                    type: array
                    items:
                      $ref: '#/components/schemas/stt_models'
                  tts:
                    type: array
                    items:
                      $ref: '#/components/schemas/tts_models'
        '400':
          $ref: '#/components/responses/projects_bad_request'
  /v1/projects/{project_id}/models/{model_id}:
    description: Manage your project models
    parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/model_id'
    get:
      summary: Get a Project Model
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: getProjectModel
      description: Returns metadata for a specific model
      responses:
        '200':
          description: A specific model
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/stt_models'
                  - $ref: '#/components/schemas/tts_models'
        '400':
          $ref: '#/components/responses/projects_bad_request'
  /v1/projects/{project_id}/keys:
    description: Manage your project keys
    parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/keys_status'
    get:
      summary: List Project Keys
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: listProjectKeys
      description: Retrieves all API keys associated with the specified project
      parameters:
        - $ref: '#/components/parameters/project_id'
      responses:
        '200':
          description: A list of API keys
          content:
            application/json:
              schema:
                type: object
                properties:
                  api_keys:
                    type: array
                    items:
                      $ref: '#/components/schemas/keys'
        '403':
          $ref: '#/components/responses/authentication_failed'
        '404':
          $ref: '#/components/responses/project_not_found'
    post:
      summary: Create a Project Key
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: createProjectKey
      description: Creates a new API key with specified settings for the project
      parameters:
        - $ref: '#/components/parameters/project_id'
      requestBody:
        description: The API key settings
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/keys'
      responses:
        '200':
          description: API key created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/key_created'
        '403':
          $ref: '#/components/responses/authentication_failed'
        '404':
          $ref: '#/components/responses/project_not_found'
  /v1/projects/{project_id}/keys/{key_id}:
    description: Manage your project keys
    get:
      summary: Get a Project Key
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: getProjectKey
      description: Retrieves information about a specified API key
      parameters:
        - $ref: '#/components/parameters/project_id'
        - $ref: '#/components/parameters/key_id'
      responses:
        '200':
          description: A specific API key
          content:
            application/json:
              schema:
                type: object
                properties:
                  item:
                    $ref: '#/components/schemas/key'
        '403':
          $ref: '#/components/responses/authentication_failed'
        '404':
          $ref: '#/components/responses/project_not_found'
    delete:
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: deleteProjectKey
      summary: Delete a Project Key
      description: Deletes an API key for a specific project
      parameters:
        - $ref: '#/components/parameters/project_id'
        - $ref: '#/components/parameters/key_id'
      responses:
        '200':
          description: API key deleted
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: A message indicating that the API key was deleted
              example:
                message: Successfully deleted the API key!
        '403':
          $ref: '#/components/responses/authentication_failed'
        '404':
          $ref: '#/components/responses/project_not_found'
  /v1/projects/{project_id}/members:
    description: Manage your project members
    get:
      summary: List Project Members
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: listProjectMembers
      description: Retrieves a list of account objects for a specific project
      parameters:
        - $ref: '#/components/parameters/project_id'
      responses:
        '200':
          description: A list of account objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  members:
                    type: array
                    items:
                      type: object
                      properties:
                        member_id:
                          type: string
                          description: The unique identifier of the member
                          scopes:
                            type: array
                            items:
                              type: string
                            description: The API scopes of the member
                          email:
                            type: string
                            first_name:
                              type: string
                            last_name:
                              type: string
        '403':
          $ref: '#/components/responses/authentication_failed'
        '404':
          $ref: '#/components/responses/project_not_found'
  /v1/projects/{project_id}/members/{member_id}:
    description: Manage your project members
    delete:
      summary: Delete a Project Member
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: deleteProjectMember
      description: Removes a member from the project using their unique member ID
      parameters:
        - $ref: '#/components/parameters/project_id'
        - $ref: '#/components/parameters/member_id'
      responses:
        '200':
          description: Delete the specific member from the project
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: confirmation message
                example:
                  message: Successfully removed account from project.
        '403':
          $ref: '#/components/responses/authentication_failed'
        '404':
          $ref: '#/components/responses/project_not_found'
  /v1/projects/{project_id}/members/{member_id}/scopes:
    description: Manage your project members
    get:
      summary: List Project Member Scopes
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: listProjectMemberScopes
      description: Retrieves a list of scopes for a specific member
      parameters:
        - $ref: '#/components/parameters/project_id'
        - $ref: '#/components/parameters/member_id'
      responses:
        '200':
          description: A list of scopes for a specific member
          content:
            application/json:
              schema:
                type: object
                properties:
                  scopes:
                    type: array
                    items:
                      type: string
                    description: The API scopes of the member
        '403':
          $ref: '#/components/responses/authentication_failed'
        '404':
          $ref: '#/components/responses/project_not_found'
    put:
      summary: Update Project Member Scopes
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: updateProjectMemberScopes
      description: Updates the scopes for a specific member
      parameters:
        - $ref: '#/components/parameters/project_id'
        - $ref: '#/components/parameters/member_id'
      requestBody:
        description: A scope to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update_member_scope'
      responses:
        '200':
          description: Updated the scopes for a specific member
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: confirmation message
                example:
                  message: Successfully updated the account scopes.
        '403':
          $ref: '#/components/responses/authentication_failed'
        '404':
          $ref: '#/components/responses/project_not_found'
  /v1/projects/{project_id}/invites:
    description: Manage your project invites
    get:
      summary: List Project Invites
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: listProjectInvites
      description: Generates a list of invites for a specific project
      parameters:
        - $ref: '#/components/parameters/project_id'
      responses:
        '200':
          description: A list of invites for a specific project
          content:
            application/json:
              schema:
                type: object
                properties:
                  invites:
                    type: array
                    items:
                      type: object
                      properties:
                        email:
                          type: string
                          description: The email address of the invitee
                        scope:
                          type: string
                          description: The scope of the invitee
    post:
      summary: Create a Project Invite
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: createProjectInvite
      description: Generates an invite for a specific project
      parameters:
        - $ref: '#/components/parameters/project_id'
      requestBody:
        description: email to invite to the project
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create_project_invite'
      responses:
        '200':
          description: The invite was successfully generated
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: confirmation message
        '400':
          $ref: '#/components/responses/invalid_request'
        '401':
          $ref: '#/components/responses/project_unauthorized'
        '403':
          $ref: '#/components/responses/authentication_failed'
        '404':
          $ref: '#/components/responses/project_not_found'
  /v1/projects/{project_id}/invites/{email}:
    description: Manage your project invites
    delete:
      summary: Delete a Project Invite
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: deleteProjectInvite
      description: Deletes an invite for a specific project
      parameters:
        - $ref: '#/components/parameters/project_id'
        - $ref: '#/components/parameters/email'
      responses:
        '200':
          description: The invite was successfully deleted
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: confirmation message
        '400':
          $ref: '#/components/responses/invalid_request'
        '401':
          $ref: '#/components/responses/project_unauthorized'
        '403':
          $ref: '#/components/responses/authentication_failed'
        '404':
          $ref: '#/components/responses/project_not_found'
  /v1/projects/{project_id}/leave:
    description: Manage your project accounts
    delete:
      summary: Leave a Project
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: deleteProjectLeave
      description: Removes the authenticated account from the specific project
      parameters:
        - $ref: '#/components/parameters/project_id'
      responses:
        '200':
          description: Successfully removed account from project
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: confirmation message
        '400':
          $ref: '#/components/responses/invalid_request'
        '401':
          $ref: '#/components/responses/project_unauthorized'
        '403':
          $ref: '#/components/responses/authentication_failed'
        '404':
          $ref: '#/components/responses/project_not_found'
  /v1/projects/{project_id}/requests:
    description: Manage your project requests
    get:
      summary: List Project Requests
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: listProjectRequests
      description: Generates a list of requests for a specific project
      parameters:
        - $ref: '#/components/parameters/project_id'
        - $ref: '#/components/parameters/start'
        - $ref: '#/components/parameters/end'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/page'
      responses:
        '200':
          description: A list of requests for a specific project
          content:
            application/json:
              schema:
                type: object
                properties:
                  page:
                    type: integer
                    description: The page number of the paginated response
                  limit:
                    type: integer
                    description: The number of results per page
                  requests:
                    type: array
                    items:
                      $ref: '#/components/schemas/request'
        '400':
          $ref: '#/components/responses/projects_bad_request'
        '403':
          $ref: '#/components/responses/authentication_failed'
        '404':
          $ref: '#/components/responses/project_not_found'
  /v1/projects/{project_id}/requests/{request_id}:
    description: Manage your project requests
    get:
      summary: Get a Project Request
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: getProjectRequest
      description: Retrieves a specific request for a specific project
      parameters:
        - $ref: '#/components/parameters/project_id'
        - $ref: '#/components/parameters/request_id'
      responses:
        '200':
          description: A specific request for a specific project
          content:
            application/json:
              schema:
                type: object
                properties:
                  request:
                    type: object
                    $ref: '#/components/schemas/request'
  /v1/projects/{project_id}/usage:
    description: Manage your project usage
    get:
      summary: Get Project Usage
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: getProjectUsage
      description: Retrieves the usage for a specific project
      parameters:
        - $ref: '#/components/parameters/project_id'
        - $ref: '#/components/parameters/start'
        - $ref: '#/components/parameters/end'
        - $ref: '#/components/parameters/project_filters'
      responses:
        '200':
          $ref: '#/components/responses/usage'
        '400':
          $ref: '#/components/responses/invalid_request'
        '401':
          $ref: '#/components/responses/project_unauthorized'
        '403':
          $ref: '#/components/responses/authentication_failed'
        '404':
          $ref: '#/components/responses/project_not_found'
  /v1/projects/{project_id}/usage/fields:
    description: Manage your project usage
    get:
      summary: List Project Usage Fields
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: listProjectUsageFields
      description: Lists the features, models, tags, languages, and processing method used for requests in the specified project
      parameters:
        - $ref: '#/components/parameters/project_id'
        - $ref: '#/components/parameters/start'
        - $ref: '#/components/parameters/end'
      responses:
        '200':
          $ref: '#/components/responses/fields'
        '400':
          $ref: '#/components/responses/invalid_request'
        '401':
          $ref: '#/components/responses/project_unauthorized'
        '403':
          $ref: '#/components/responses/authentication_failed'
        '404':
          $ref: '#/components/responses/project_not_found'
  /v1/projects/{project_id}/usage/breakdown:
    description: Manage your project usage breakdown with various filter options
    get:
      summary: Get Project Usage Breakdown
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: getProjectUsageBreakdown
      description: |
        | Parameter | Type | Description |
        |-----------|------|-------------|
        | accessor | boolean | The public API key accessor used |
        | deployment | boolean | The deployment type used |
        | endpoint | boolean | The endpoint used |
        | feature_set | boolean | The collection of features used |
        | model | boolean | The model used |
        | method | boolean | The processing method used |
        | tags | boolean | Any tags used |
        | diarize | boolean | Filter by diarization usage |
        | utterances | boolean | Filter by utterances usage |
      parameters:
        - $ref: '#/components/parameters/project_id'
        - $ref: '#/components/parameters/start'
        - $ref: '#/components/parameters/end'
        - $ref: '#/components/parameters/project_filters'
        - $ref: '#/components/parameters/usage_breakdown_filters'
      responses:
        '200':
          $ref: '#/components/responses/usage_breakdown'
        '400':
          $ref: '#/components/responses/projects_bad_request'
        '401':
          $ref: '#/components/responses/project_unauthorized'
        '404':
          $ref: '#/components/responses/project_not_found'
  /v1/projects/{project_id}/purchases:
    description: Manage your project purchases
    get:
      summary: List Project Purchases
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: listProjectPurchases
      description: Returns the original purchased amount on an order transaction
      parameters:
        - $ref: '#/components/parameters/project_id'
        - $ref: '#/components/parameters/start'
        - $ref: '#/components/parameters/limit'
      responses:
        '200':
          $ref: '#/components/responses/purchases'
        '400':
          $ref: '#/components/responses/projects_bad_request'
  /v1/models:
    description: Manage your project models
    get:
      summary: List Project Models
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: listModels
      description: Returns metadata on all the latest public models. To retrieve custom models, use the Get Projects Models endpoint
      parameters:
        - $ref: '#/components/parameters/include_outdated'
      responses:
        '200':
          $ref: '#/components/responses/all_models'
        '400':
          $ref: '#/components/responses/projects_bad_request'
  /v1/models/{model_id}:
    description: Manage your project models
    get:
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: getModel
      summary: Get a specific Model
      description: Returns metadata for a specific public model
      parameters:
        - $ref: '#/components/parameters/model_id'
      responses:
        '200':
          $ref: '#/components/responses/model'
        '400':
          $ref: '#/components/responses/projects_bad_request'
  /v1/projects/{project_id}/self-hosted/distribution/credentials:
    description: Returns sets of distribution credentials for the specified project
    get:
      summary: List Project Self-Hosted Distribution Credentials
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: listSelfHostedDistCreds
      description: Lists sets of distribution credentials for the specified project
      parameters:
        - $ref: '#/components/parameters/project_id'
      responses:
        '200':
          $ref: '#/components/responses/credentials'
        '403':
          $ref: '#/components/responses/authentication_failed'
        '404':
          $ref: '#/components/responses/project_not_found'
    post:
      summary: Create a Project Self-Hosted Distribution Credential
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: createSelfHostedDistCreds
      description: Creates a set of distribution credentials for the specified project
      parameters:
        - $ref: '#/components/parameters/project_id'
        - $ref: '#/components/parameters/distribution_scopes'
        - $ref: '#/components/parameters/distribution_provider'
      requestBody:
        description: The set of distribution credentials to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create_distribution_creds'
  /v1/projects/{project_id}/self-hosted/distribution/credentials/{distribution_credentials_id}:
    description: Returns a single set of distribution credentials for the specified project
    get:
      summary: Get a Project Self-Hosted Distribution Credential
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: getSelfHostedCredentials
      description: Returns a set of distribution credentials for the specified project
      parameters:
        - $ref: '#/components/parameters/project_id'
        - $ref: '#/components/parameters/distribution_credentials_id'
      responses:
        '200':
          $ref: '#/components/responses/credential'
        '403':
          $ref: '#/components/responses/authentication_failed'
        '404':
          $ref: '#/components/responses/project_not_found'
    delete:
      summary: Delete a Project Self-Hosted Distribution Credential
      tags:
        - Management API
      security:
        - ApiKeyAuth: []
      operationId: deleteSelfHostedDistCreds
      description: Deletes a set of distribution credentials for the specified project
      parameters:
        - $ref: '#/components/parameters/project_id'
        - $ref: '#/components/parameters/distribution_credentials_id'
      responses:
        '200':
          $ref: '#/components/responses/credential'
        '403':
          $ref: '#/components/responses/authentication_failed'
        '404':
          $ref: '#/components/responses/project_not_found'
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: |
        Use the `Authorization` header with the format `token <API KEY>`. Example:`Authorization token 12345abcdef`
  parameters:
    callback:
      name: callback
      in: query
      required: false
      description: URL to which we'll make the callback request
      schema:
        type: string
    callback_method:
      name: callback_method
      in: query
      required: false
      description: HTTP method by which the callback request will be made
      schema:
        default: POST
        enum:
          - POST
          - PUT
    custom_topic:
      name: custom_topic
      in: query
      required: false
      description: Custom topics you want the model to detect within your input audio or text if present Submit up to 100
      style: form
      explode: true
      schema:
        oneOf:
          - type: string
          - type: array
            items:
              type: string
            maxItems: 100
    custom_topic_mode:
      name: custom_topic_mode
      in: query
      required: false
      description: Sets how the model will interpret strings submitted to the `custom_topic` param. When `strict`, the model will only return topics submitted using the `custom_topic` param. When `extended`, the model will return its own detected topics in addition to those submitted using the `custom_topic` param
      schema:
        default: extended
        type: string
        enum:
          - extended
          - strict
    custom_intent:
      name: custom_intent
      in: query
      required: false
      description: Custom intents you want the model to detect within your input audio if present
      style: form
      explode: true
      schema:
        oneOf:
          - type: string
          - type: array
            items:
              type: string
              maxItems: 100
    custom_intent_mode:
      name: custom_intent_mode
      in: query
      required: false
      description: Sets how the model will interpret intents submitted to the `custom_intent` param. When `strict`, the model will only return intents submitted using the `custom_intent` param. When `extended`, the model will return its own detected intents in addition those submitted using the `custom_intents` param
      schema:
        default: extended
        type: string
        enum:
          - extended
          - strict
    detect_entities:
      name: detect_entities
      in: query
      required: false
      description: Identifies and extracts key entities from content in submitted audio
      schema:
        default: false
        type: boolean
    detect_language:
      name: detect_language
      in: query
      required: false
      description: Identifies the dominant language spoken in submitted audio
      style: form
      explode: true
      schema:
        oneOf:
          - type: boolean
            default: false
          - type: array
            items:
              type: string
    diarize_version:
      name: diarize_version
      in: query
      required: false
      description: Version of the diarization feature to use. Only used when the diarization feature is enabled (`diarize=true` is passed to the API)
      schema:
        type: string
        default: v2
    diarize:
      name: diarize
      in: query
      required: false
      description: Recognize speaker changes. Each word in the transcript will be assigned a speaker number starting at 0
      schema:
        default: false
        type: boolean
    dictation:
      name: dictation
      in: query
      required: false
      description: Identify and extract key entities from content in submitted audio
      schema:
        default: false
        type: boolean
    encoding:
      name: encoding
      in: query
      required: false
      description: Specify the expected encoding of your submitted audio
      schema:
        type: string
        enum:
          - linear16
          - flac
          - mulaw
          - amr-nb
          - amr-wb
          - opus
          - speex
          - g729
    extra:
      name: extra
      in: query
      required: false
      description: Arbitrary key-value pairs that are attached to the API response for usage in downstream processing
      style: form
      explode: true
      schema:
        oneOf:
          - type: string
          - type: array
            items:
              type: string
    filler_words:
      name: filler_words
      in: query
      required: false
      description: Filler Words can help transcribe interruptions in your audio, like "uh" and "um"
      schema:
        default: false
        type: boolean
    intents:
      name: intents
      in: query
      required: false
      description: Recognizes speaker intent throughout a transcript or text
      schema:
        default: false
        type: boolean
    keyterm:
      name: keyterm
      in: query
      required: false
      description: Key term prompting can boost or suppress specialized terminology and brands. Only compatible with Nova-3
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
    keywords:
      name: keywords
      in: query
      required: false
      description: Keywords can boost or suppress specialized terminology and brands
      style: form
      explode: true
      schema:
        oneOf:
          - type: string
          - type: array
            items:
              type: string
    language:
      name: language
      in: query
      required: false
      description: The [BCP-47 language tag](https://tools.ietf.org/html/bcp47) that hints at the primary spoken language. Depending on the Model and API endpoint you choose only certain languages are available
      schema:
        type: string
        default: en
        enum:
          - bg
          - ca
          - zh
          - zh-CN
          - zh-TW
          - zh-HK
          - zh-Hans
          - zh-Hant
          - cs
          - da
          - da-DK
          - nl
          - nl-BE
          - en
          - en-US
          - en-AU
          - en-GB
          - en-NZ
          - en-IN
          - et
          - fi
          - fr
          - fr-CA
          - de
          - de-CH
          - el
          - hi
          - hi-Latn
          - hu
          - id
          - it
          - ja
          - ko
          - ko-KR
          - lv
          - lt
          - ms
          - 'no'
          - pl
          - pt
          - pt-BR
          - pt-PT
          - ro
          - ru
          - sk
          - es
          - es-419
          - es-LATAM
          - sv
          - sv-SE
          - taq
          - th
          - th-TH
          - tr
          - uk
          - vi
    measurements:
      name: measurements
      in: query
      required: false
      description: Spoken measurements will be converted to their corresponding abbreviations
      schema:
        default: false
        type: boolean
    model:
      name: model
      in: query
      required: false
      description: AI model used to process submitted audio
      schema:
        default: base-general
        oneOf:
          - type: string
            description: Our public models available to all accounts
            enum:
              - 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
          - type: string
            description: Custom string if you've had a model trained by Deepgram
        example: nova-3
    multichannel:
      name: multichannel
      in: query
      required: false
      description: Transcribe each audio channel independently
      schema:
        default: false
        type: boolean
    numerals:
      name: numerals
      in: query
      required: false
      description: Numerals converts numbers from written format to numerical format
      schema:
        default: false
        type: boolean
    paragraphs:
      name: paragraphs
      in: query
      required: false
      description: Splits audio into paragraphs to improve transcript readability
      schema:
        default: false
        type: boolean
    profanity_filter:
      name: profanity_filter
      in: query
      required: false
      description: Profanity Filter looks for recognized profanity and converts it to the nearest recognized non-profane word or removes it from the transcript completely
      schema:
        default: false
        type: boolean
    punctuate:
      name: punctuate
      in: query
      required: false
      description: Add punctuation and capitalization to the transcript
      schema:
        default: false
        type: boolean
    redact:
      name: redact
      in: query
      required: false
      description: Redaction removes sensitive information from your transcripts
      style: form
      explode: true
      schema:
        default: false
        oneOf:
          - type: string
          - type: array
            items:
              type: string
              enum:
                - pci
                - pii
                - numbers
            maxItems: 100
    replace:
      name: replace
      in: query
      required: false
      description: Search for terms or phrases in submitted audio and replaces them
      style: form
      explode: true
      schema:
        oneOf:
          - type: string
          - type: array
            items:
              type: string
    search:
      name: search
      in: query
      required: false
      description: Search for terms or phrases in submitted audio
      style: form
      explode: true
      schema:
        oneOf:
          - type: string
          - type: array
            items:
              type: string
    sentiment:
      name: sentiment
      in: query
      required: false
      description: Recognizes the sentiment throughout a transcript or text
      schema:
        default: false
        type: boolean
    smart_format:
      name: smart_format
      in: query
      required: false
      description: Apply formatting to transcript output. When set to true, additional formatting will be applied to transcripts to improve readability
      schema:
        default: false
        type: boolean
    summarize:
      name: summarize
      in: query
      required: false
      description: Summarize content. For Listen API, supports string version option. For Read API, accepts boolean only.
      schema:
        oneOf:
          - title: Listen API Version Option
            type: string
            enum:
              - v2
              - v1
          - title: Read API Boolean Option
            type: boolean
            default: false
    tag:
      name: tag
      in: query
      required: false
      description: Label your requests for the purpose of identification during usage reporting
      style: form
      explode: true
      schema:
        oneOf:
          - type: string
          - type: array
            items:
              type: string
    topics:
      name: topics
      in: query
      required: false
      description: Detect topics throughout a transcript or text
      schema:
        default: false
        type: boolean
    utterances:
      name: utterances
      in: query
      required: false
      description: Segments speech into meaningful semantic units
      schema:
        default: false
        type: boolean
    utt_split:
      name: utt_split
      in: query
      required: false
      description: Seconds to wait before detecting a pause between words in submitted audio
      schema:
        default: 0.8
        type: number
    version:
      name: version
      in: query
      required: false
      description: Version of an AI model to use
      schema:
        default: latest
        oneOf:
          - type: string
            description: Use the latest version of a model
            enum:
              - latest
          - type: string
            description: Use a previous version of a model
    bit_rate:
      name: bit_rate
      in: query
      required: false
      description: The bitrate of the audio in bits per second. Choose from predefined ranges or specific values based on the encoding type.
      schema:
        default: 48000
        oneOf:
          - title: mp3(default)
            description: Encoding - mp3(default). Supported bitrates - 32000, 48000(default) bps.
            type: integer
            nullable: true
            enum:
              - 32000
              - 48000
            x-fern-enum:
              '32000':
                name: ThirtyTwoThousand
              '48000':
                name: FortyEightThousand
          - title: opus
            description: Encoding - opus. Bitrate range - 4000-650000 bps.
            type: integer
            nullable: true
            minimum: 4000
            maximum: 650000
            x-fern-enum:
              '4000':
                name: FourThousand
              '650000':
                name: SixHundredFiftyThousand
          - title: aac
            description: Encoding -aac. Bitrate range - 4000-192000 bps.
            type: integer
            nullable: true
            minimum: 4000
            maximum: 192000
            x-fern-enum:
              '4000':
                name: FourThousand
              '192000':
                name: OneHundredNinetyTwoThousand
    container:
      name: container
      in: query
      required: false
      description: Container specifies the file format wrapper for the output audio. The available options depend on the encoding type.
      schema:
        default: wav
        oneOf:
          - title: none
            description: No container.
            type: string
            enum:
              - none
            nullable: true
          - title: linear16
            description: Encoding - linear16. Supported container - wav (default), or no container.
            type: string
            enum:
              - wav
            nullable: true
          - title: mulaw
            description: Encoding - mulaw. Supported container - wav (default), or no container.
            type: string
            enum:
              - wav
            nullable: true
          - title: alaw
            description: Encoding - alaw. Supported container - wav (default), or no container.
            type: string
            enum:
              - wav
            nullable: true
          - title: opus
            description: Encoding - opus. Supported container - ogg (default).
            type: string
            enum:
              - ogg
    speak_encoding:
      name: encoding
      in: query
      required: false
      description: Encoding allows you to specify the expected encoding of your audio output
      schema:
        default: mp3
        oneOf:
          - title: linear16
            description: Encoding - linear16. Uncompressed, high-quality audio format often used for telephony or audio processing.
            type: string
            enum:
              - linear16
          - title: flac
            description: Encoding - flac. Lossless audio format for high-quality compression.
            type: string
            enum:
              - flac
          - title: mulaw
            description: Encoding - mulaw. Compressed audio format commonly used in telephony.
            type: string
            enum:
              - mulaw
          - title: alaw
            description: Encoding - alaw. Similar to mulaw but used in international telephony.
            type: string
            enum:
              - alaw
          - title: mp3
            description: Encoding - mp3. Popular compressed audio format for music and streaming.
            type: string
            enum:
              - mp3
          - title: opus
            description: Encoding - opus. High-compression audio format optimized for real-time communications.
            type: string
            enum:
              - opus
          - title: aac
            description: Encoding - aac. Advanced audio format offering better quality at smaller file sizes than mp3.
            type: string
            enum:
              - aac
    speak_model:
      name: model
      in: query
      required: false
      description: AI model used to process submitted text
      schema:
        default: aura-asteria-en
        type: string
        enum:
          - 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
      example: aura-asteria-en
    speak_sample_rate:
      name: sample_rate
      in: query
      required: false
      description: Sample Rate specifies the sample rate for the output audio. Based on the encoding, different sample rates are supported. For some encodings, the sample rate is not configurable
      schema:
        default: 24000
        oneOf:
          - title: linear16
            description: Encoding - linear16. Supported sample rates - 8000, 16000, 24000, 32000, 48000 Hz.
            type: integer
            nullable: true
            enum:
              - 8000
              - 16000
              - 24000
              - 32000
              - 48000
            x-fern-enum:
              '8000':
                name: EightThousand
              '16000':
                name: SixteenThousand
              '24000':
                name: TwentyFourThousand
              '32000':
                name: ThirtyTwoThousand
              '48000':
                name: FortyEightThousand
          - title: mulaw
            description: Encoding - mulaw. Supported sample rates - 8000, 16000 Hz.
            type: integer
            nullable: true
            enum:
              - 8000
              - 16000
            x-fern-enum:
              '8000':
                name: EightThousand
              '16000':
                name: SixteenThousand
          - title: alaw
            description: Encoding - alaw. Supported sample rates - 8000, 16000 Hz.
            type: integer
            nullable: true
            enum:
              - 8000
              - 16000
            x-fern-enum:
              '8000':
                name: EightThousand
              '16000':
                name: SixteenThousand
          - title: mp3
            description: Encoding - mp3. Sample rate is fixed and not configurable (22050 Hz).
            type: integer
            nullable: true
            enum:
              - 22050
            x-fern-enum:
              '22050':
                name: TwentyTwoThousandFifty
          - title: opus
            description: Encoding - opus. Sample rate is fixed at 48000 Hz.
            type: integer
            nullable: true
            enum:
              - 48000
            x-fern-enum:
              '48000':
                name: FortyEightThousand
    project_id:
      name: project_id
      in: path
      required: true
      description: The unique identifier of the project
      schema:
        type: string
      example: 123456-7890-1234-5678-901234
    limit:
      name: limit
      in: query
      required: false
      description: Number of results to return per page. Default 10. Range [1,1000]
      schema:
        type: integer
        default: 10
        minimum: 1
        maximum: 1000
    start:
      name: start
      in: query
      required: false
      description: Start date of the requested date range. Formats accepted are YYYY-MM-DD, YYYY-MM-DDTHH:MM:SS, or YYYY-MM-DDTHH:MM:SS+HH:MM
      schema:
        type: string
        format: date-time
    end:
      name: end
      in: query
      required: false
      description: End date of the requested date range. Formats accepted are YYYY-MM-DD, YYYY-MM-DDTHH:MM:SS, or YYYY-MM-DDTHH:MM:SS+HH:MM
      schema:
        type: string
        format: date-time
    page:
      name: page
      in: query
      required: false
      description: Navigate and return the results to retrieve specific portions of information of the response
      schema:
        type: integer
    balance_id:
      name: balance_id
      in: path
      required: true
      description: The unique identifier of the balance
      schema:
        type: string
      example: 123456-7890-1234-5678-901234
    include_outdated:
      name: include_outdated
      in: query
      required: false
      description: returns non-latest versions of models
      schema:
        type: boolean
    model_id:
      name: model_id
      in: path
      required: true
      description: The specific UUID of the model
      schema:
        type: string
      example: af6e9977-99f6-4d8f-b6f5-dfdf6fb6e291
    keys_status:
      name: status
      in: query
      required: false
      description: Only return keys with a specific status
      schema:
        type: string
        enum:
          - active
          - expired
    key_id:
      name: key_id
      in: path
      required: true
      description: The unique identifier of the API key
      schema:
        type: string
      example: '123456789012345678901234'
    member_id:
      name: member_id
      in: path
      required: true
      description: The unique identifier of the Member
      schema:
        type: string
      example: '123456789012345678901234'
    email:
      name: email
      in: path
      required: true
      description: The email address of the member
      schema:
        type: string
      example: john.doe@example.com
    request_id:
      name: request_id
      in: path
      required: true
      description: The unique identifier of the request
      schema:
        type: string
      example: 123456-7890-1234-5678-901234
    project_filters:
      name: project_filters
      in: query
      required: false
      description: |
        Filter options for project features. Each filter can be used as an individual query parameter.
        Example: ?diarize=true&utterances=true
      style: form
      explode: true
      schema:
        type: object
        properties:
          alternatives:
            type: boolean
          callback_method:
            type: boolean
          callback:
            type: boolean
          channels:
            type: boolean
          custom_intent_mode:
            type: boolean
          custom_intent:
            type: boolean
          custom_topic_mode:
            type: boolean
          custom_topic:
            type: boolean
          detect_entities:
            type: boolean
          detect_language:
            type: boolean
          diarize:
            type: boolean
          diarize_version:
            type: boolean
          dictation:
            type: boolean
          detect_topics:
            type: boolean
          encoding:
            type: boolean
          extra:
            type: boolean
          filler_words:
            type: boolean
          intents:
            type: boolean
          keywords:
            type: boolean
          language:
            type: boolean
          measurements:
            type: boolean
          model:
            type: boolean
          multichannel:
            type: boolean
          numerals:
            type: boolean
          paragraphs:
            type: boolean
          profanity_filter:
            type: boolean
          punctuate:
            type: boolean
          redact:
            type: boolean
          replace:
            type: boolean
          sample_rate:
            type: boolean
          smart_format:
            type: boolean
          search:
            type: boolean
          sentiment:
            type: boolean
          summarize:
            type: boolean
          tag:
            type: boolean
          topics:
            type: boolean
          utterances:
            type: boolean
          utt_split:
            type: boolean
          version:
            type: boolean
    usage_breakdown_filters:
      name: usage_breakdown_filters
      in: query
      required: false
      description: |
        Filter options for usage breakdown. Multiple filters can be used with '&' prefix.
        Example: &model={model_id}&tags={tag}&accessor={accessor_id}
      schema:
        type: object
        properties:
          accessor:
            type: string
            description: Filter results by specific accessor ID
          deployment:
            type: string
            description: Filter results by specific deployment type
          endpoint:
            type: string
            description: Filter results by specific endpoint
          feature_set:
            type: string
            description: Filter results by specific feature set
          model:
            type: string
            description: Filter results by specific model ID
          method:
            type: string
            description: Filter results by specific processing method
          tags:
            type: string
            description: Filter results by specific tags
    distribution_scopes:
      name: scopes
      in: query
      required: true
      description: List of permission scopes for the credentials
      schema:
        default:
          - self-hosted:products
        type: array
        items:
          type: string
          enum:
            - 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
    distribution_provider:
      name: provider
      in: query
      required: true
      description: The provider of the distribution service
      schema:
        default: quay
        type: string
        enum:
          - quay
    distribution_credentials_id:
      name: distribution_credentials_id
      in: path
      required: true
      description: The UUID of the distribution credentials
      schema:
        type: string
      example: 8b36cfd0-472f-4a21-833f-2d6343c3a2f3
  schemas:
    ListenRequestUrl:
      type: object
      description: Audio file URL to transcribe
      required:
        - url
      properties:
        url:
          type: string
          format: uri
          example: https://dpgr.am/spacewalk.wav
    ListenRequestFile:
      type: string
      format: binary
      description: Binary audio file to transcribe
      example: <audiofile>
    metadata:
      required:
        - request_id
        - sha256
        - created
        - duration
        - channels
        - models
        - model_info
      type: object
      properties:
        transaction_key:
          type: string
          default: deprecated
          deprecated: true
        request_id:
          type: string
          format: uuid
          example: a847f427-4ad5-4d67-9b95-db801e58251c
        sha256:
          type: string
          example: 154e291ecfa8be6ab8343560bcc109008fa7853eb5372533e8efdefc9b504c33
        created:
          type: string
          format: date-time
          example: '2024-05-12T18:57:13.426Z'
        duration:
          type: number
          example: 25.933313
        channels:
          type: number
          example: 1
        models:
          type: array
          items:
            type: string
          example:
            - 30089e05-99d1-4376-b32e-c263170674af
        model_info:
          type: object
          patternProperties:
            ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$:
              type: object
              properties:
                name:
                  type: string
                version:
                  type: string
                arch:
                  type: string
          additionalProperties: false
          example:
            30089e05-99d1-4376-b32e-c263170674af:
              name: 2-general-nova
              version: 2024-01-09.29447
              arch: nova-2
        summary_info:
          type: object
          properties:
            model_uuid:
              type: string
              example: 67875a7f-c9c4-48a0-aa55-5bdb8a91c34a
            input_tokens:
              type: number
              example: 95
            output_tokens:
              type: number
              example: 63
        sentiment_info:
          type: object
          properties:
            model_uuid:
              type: string
              example: 80ab3179-d113-4254-bd6b-4a2f96498695
            input_tokens:
              type: number
              example: 105
            output_tokens:
              type: number
              example: 105
        topics_info:
          type: object
          properties:
            model_uuid:
              type: string
              example: 80ab3179-d113-4254-bd6b-4a2f96498695
            input_tokens:
              type: number
              example: 105
            output_tokens:
              type: number
              example: 7
        intents_info:
          type: object
          properties:
            model_uuid:
              type: string
              example: 80ab3179-d113-4254-bd6b-4a2f96498695
            input_tokens:
              type: number
              example: 105
            output_tokens:
              type: number
              example: 4
        tags:
          type: array
          items:
            type: string
          example:
            - test
    channels:
      type: array
      items:
        type: object
        properties:
          search:
            type: array
            items:
              type: object
              properties:
                query:
                  type: string
                hits:
                  type: array
                  items:
                    type: object
                    properties:
                      confidence:
                        type: number
                        format: float
                      start:
                        type: number
                        format: float
                      end:
                        type: number
                        format: float
                      snippet:
                        type: string
          alternatives:
            type: array
            items:
              type: object
              properties:
                transcript:
                  type: string
                confidence:
                  type: number
                  format: float
                words:
                  type: array
                  items:
                    type: object
                    properties:
                      word:
                        type: string
                      start:
                        type: number
                        format: float
                      end:
                        type: number
                        format: float
                      confidence:
                        type: number
                        format: float
                paragraphs:
                  type: object
                  properties:
                    transcript:
                      type: string
                    paragraphs:
                      type: array
                      items:
                        type: object
                        properties:
                          sentences:
                            type: array
                            items:
                              type: object
                              properties:
                                text:
                                  type: string
                                start:
                                  type: number
                                  format: float
                                end:
                                  type: number
                                  format: float
                          speaker:
                            type: integer
                            format: int32
                          num_words:
                            type: integer
                            format: int32
                          start:
                            type: number
                            format: float
                          end:
                            type: number
                            format: float
                summaries:
                  type: array
                  items:
                    type: object
                    properties:
                      summary:
                        type: string
                      start_word:
                        type: integer
                        format: int32
                      end_word:
                        type: integer
                        format: int32
                topics:
                  type: array
                  items:
                    type: object
                    properties:
                      text:
                        type: string
                      start_word:
                        type: integer
                        format: int32
                      end_word:
                        type: integer
                        format: int32
                      topics:
                        type: array
                        items:
                          type: string
          detected_language:
            type: string
    utterances:
      type: array
      items:
        type: object
        properties:
          start:
            type: number
            format: float
          end:
            type: number
            format: float
          confidence:
            type: number
            format: float
          channel:
            type: integer
            format: int32
          transcript:
            type: string
          words:
            type: array
            items:
              type: object
              properties:
                word:
                  type: string
                start:
                  type: number
                  format: float
                end:
                  type: number
                  format: float
                confidence:
                  type: number
                  format: float
                speaker:
                  type: integer
                  format: int32
                speaker_confidence:
                  type: integer
                  format: int32
                punctuated_word:
                  type: string
          speaker:
            type: integer
            format: int32
          id:
            type: string
            format: uuid
    summary:
      type: object
      properties:
        result:
          type: string
          example: success
        short:
          type: string
          example: Speaker 0 discusses the significance of the first all-female spacewalk with an all-female team, stating that it is a tribute to the skilled and qualified women who were denied opportunities in the past.
    topics:
      type: object
      description: Output whenever `topics=true` is used
      properties:
        results:
          type: object
          properties:
            topics:
              type: object
              properties:
                segments:
                  type: array
                  items:
                    type: object
                    properties:
                      text:
                        type: string
                        example: And, um, I think if it signifies anything, it is, uh, to honor the the women who came before us who, um, were skilled and qualified, um, and didn't get the the same opportunities that we have today.
                      start_word:
                        type: integer
                        example: 32
                      end_word:
                        type: integer
                        example: 69
                      topics:
                        type: array
                        items:
                          type: object
                          properties:
                            topic:
                              type: string
                              example: Spacewalk
                            confidence_score:
                              type: number
                              format: float
                              example: 0.91581345
    intents:
      type: object
      description: Output whenever `intents=true` is used
      properties:
        results:
          type: object
          properties:
            intents:
              type: object
              properties:
                segments:
                  type: array
                  items:
                    type: object
                    properties:
                      text:
                        type: string
                        example: If you found this valuable, you can subscribe to the show on spotify or your favorite podcast app.
                      start_word:
                        type: integer
                        example: 354
                      end_word:
                        type: integer
                        example: 414
                      intents:
                        type: array
                        items:
                          type: object
                          properties:
                            intent:
                              type: string
                              example: Encourage podcasting
                            confidence_score:
                              type: number
                              format: float
                              example: 0.0038975573
    sentiments:
      type: object
      description: Output whenever `sentiment=true` is used
      properties:
        segments:
          type: array
          items:
            type: object
            properties:
              text:
                type: string
                example: Yeah. As as much as, um, it's worth celebrating, uh, the first, uh, spacewalk, um, with an all-female team, I think many of us are looking forward to it just being normal. And, um, I think if it signifies anything, it is, uh, to honor the the women who came before us who, um, were skilled and qualified, um, and didn't get the the same opportunities that we have today.
              start_word:
                type: number
                example: 0
              end_word:
                type: number
                example: 69
              sentiment:
                type: string
                example: positive
              sentiment_score:
                type: number
                example: 0.5810546875
        average:
          type: object
          properties:
            sentiment:
              type: string
              example: positive
            sentiment_score:
              type: number
              example: 0.5810185185185185
    results:
      required:
        - channels
      type: object
      properties:
        channels:
          $ref: '#/components/schemas/channels'
        utterances:
          $ref: '#/components/schemas/utterances'
        summary:
          $ref: '#/components/schemas/summary'
        topics:
          $ref: '#/components/schemas/topics'
        intents:
          $ref: '#/components/schemas/intents'
        sentiments:
          $ref: '#/components/schemas/sentiments'
    response:
      description: The standard transcription response
      required:
        - metadata
        - results
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/metadata'
          x-collapse: true
        results:
          $ref: '#/components/schemas/results'
    text_request_url:
      type: object
      properties:
        url:
          type: string
          format: uri
          description: A URL pointing to the text source
        text:
          type: string
          description: The plain text to analyze
      required:
        - url
    text_request_text:
      type: object
      properties:
        url:
          type: string
          format: uri
          description: A URL pointing to the text source
        text:
          type: string
          description: The plain text to analyze
      required:
        - text
    text_request:
      oneOf:
        - $ref: '#/components/schemas/text_request_url'
        - $ref: '#/components/schemas/text_request_text'
    text_metadata:
      required:
        - request_id
        - created
        - language
        - summary_info
        - sentiment_info
        - topics_info
        - intents_info
      type: object
      properties:
        metadata:
          type: object
          properties:
            request_id:
              type: string
              format: uuid
              example: d04af392-db11-4c1d-83e1-20e34f0b8999
            created:
              type: string
              format: date-time
              example: '2024-11-18T23:47:44.674Z'
            language:
              type: string
              example: en
            summary_info:
              type: object
              properties:
                model_uuid:
                  type: string
                  format: uuid
                input_tokens:
                  type: integer
                output_tokens:
                  type: integer
            sentiment_info:
              type: object
              properties:
                model_uuid:
                  type: string
                  format: uuid
                input_tokens:
                  type: integer
                output_tokens:
                  type: integer
            topics_info:
              type: object
              properties:
                model_uuid:
                  type: string
                  format: uuid
                input_tokens:
                  type: integer
                output_tokens:
                  type: integer
            intents_info:
              type: object
              properties:
                model_uuid:
                  type: string
                  format: uuid
                input_tokens:
                  type: integer
                output_tokens:
                  type: integer
    text_summary:
      type: object
      description: Output whenever `summary=true` is used
      properties:
        results:
          type: object
          properties:
            summary:
              type: object
              properties:
                text:
                  type: string
                  example: The summary of the text submitted.
    text_results:
      type: object
      properties:
        summary:
          $ref: '#/components/schemas/text_summary'
        topics:
          $ref: '#/components/schemas/topics'
        intents:
          $ref: '#/components/schemas/intents'
        sentiments:
          $ref: '#/components/schemas/sentiments'
    text_response:
      description: The standard text response
      required:
        - metadata
        - results
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/text_metadata'
          x-collapse: true
        results:
          $ref: '#/components/schemas/text_results'
    speak_request:
      type: object
      description: Request body for text-to-speech conversion
      required:
        - text
      properties:
        text:
          type: string
          description: The text content to be converted to speech
          example: Hello, welcome to Deepgram!
    speak_response:
      type: object
      description: The standard text response
      properties:
        results:
          type: string
          format: binary
    update_projects:
      type: object
      properties:
        name:
          type: string
          description: The name of the project
      example:
        name: My Project
    stt_models:
      type: array
      items:
        type: object
        properties:
          name:
            type: string
            example: nova-3
          canonical_name:
            type: string
            example: nova-3
          architecture:
            type: string
            example: base
          languages:
            type: array
            items:
              type: string
            example:
              - en
              - en-us
          version:
            type: string
            example: 2021-11-10.1
          uuid:
            type: string
            example: 6b28e919-8427-4f32-9847-492e2efd7daf
          batch:
            type: boolean
            example: true
          streaming:
            type: boolean
            example: true
          formatted_output:
            type: boolean
            example: true
    tts_models:
      type: array
      items:
        type: object
        properties:
          name:
            type: string
            example: zeus
          canonical_name:
            type: string
            example: aura-zeus-en
          architecture:
            type: string
            example: aura
          languages:
            type: array
            items:
              type: string
            example:
              - en
              - en-us
          version:
            type: string
            example: 2024-07-30.0
          uuid:
            type: string
            example: 9c28bce5-f144-4d32-9034-843aa7aed63e
          metadata:
            type: object
            properties:
              accent:
                type: string
                example: American
              color:
                type: string
                example: '#949498'
              image:
                type: string
                example: https://static.deepgram.com/examples/avatars/zeus.jpg
              sample:
                type: string
                example: https://static.deepgram.com/examples/voices/zeus.wav
              tags:
                type: array
                items:
                  type: string
                example:
                  - masculine
    keys:
      type: array
      items:
        type: object
        properties:
          member:
            type: object
            properties:
              member_id:
                type: string
                example: 1000-2000-3000-4000
              email:
                type: string
                example: john@test.com
          api_key:
            type: object
            properties:
              api_key_id:
                type: string
                example: 1234567890abcdef1234567890abcdef
              comment:
                type: string
                example: A comment
              scopes:
                type: array
                items:
                  type: string
                example:
                  - admin
              created:
                type: string
                format: date-time
                example: '2021-01-01T00:00:00Z'
    key_created:
      type: object
      description: API key created
      properties:
        api_key_id:
          type: string
          description: The unique identifier of the API key
        key:
          type: string
          description: The API key
        comment:
          type: string
          description: A comment for the API key
        scopes:
          type: array
          description: the scopes for the API key
          items:
            type: string
        tags:
          type: array
          description: the tags for the API key
          items:
            type: string
      example:
        api_key_id: 1234567890abcdef1234567890abcdef
        key: 1234567890abcdef1234567890abcdef
        comments: a comment
        scopes:
          - member
        tags:
          - tag-1
        expiration_date: '2024-05-01T00:00:00.000000Z'
    key:
      type: object
      properties:
        member:
          type: object
          properties:
            member_id:
              type: string
              example: 1000-2000-3000-4000
            email:
              type: string
              example: john@test.com
            first_name:
              type: string
              example: John
            last_name:
              type: string
              example: Doe
            api_key:
              type: object
              properties:
                api_key_id:
                  type: string
                  example: 1234567890abcdef1234567890abcdef
                comment:
                  type: string
                  example: A comment
                scopes:
                  type: array
                  items:
                    type: string
                  example:
                    - admin
                created:
                  type: string
                  format: date-time
                  example: '2021-01-01T00:00:00Z'
    update_member_scope:
      type: object
      required:
        - scope
      properties:
        scope:
          type: string
          description: A scope to update
          example: admin
    create_project_invite:
      type: object
      description: Request body for creating a project invite
      required:
        - email
        - scope
      properties:
        email:
          type: string
          description: The email address of the invitee
        scope:
          type: string
          description: The scope of the invitee
    request:
      type: object
      description: A single request
      properties:
        request_id:
          type: string
          description: The unique identifier of the request
        project_uuid:
          type: string
          description: The unique identifier of the project
        created:
          type: string
          format: date-time
          description: The date and time the request was created
        path:
          type: string
          description: The API path of the request
        api_key_id:
          type: string
          description: The unique identifier of the API key
        response:
          type: object
          description: The response of the request
        code:
          type: integer
          description: The response code of the request
        deployment:
          type: string
          description: The deployment type
        callback:
          type: string
          description: The callback URL for the request
    create_distribution_creds:
      type: object
      description: Request body for creating distribution credentials
      properties:
        comment:
          type: string
          description: Optional comment about the credentials
  responses:
    bad_request:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              err_code:
                type: string
                description: The error code
              err_msg:
                type: string
                description: The error message
              request_id:
                type: string
                description: The request ID
            example:
              err_code: INVALID_QUERY_PARAMETER
              err_msg: Failed to deserialize query parameters...
              request_id: 123456-7890-1234-5678-901234
    unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            properties:
              err_code:
                type: string
                description: The error code
              err_msg:
                type: string
                description: The error message
              request_id:
                type: string
                description: The request ID
            example:
              err_code: INVALID_AUTH
              err_msg: Invalid credentials.
              request_id: 123456-7890-1234-5678-901234
    payment_required:
      description: Payment Required
      content:
        application/json:
          schema:
            type: object
            properties:
              err_code:
                type: string
                description: The error code
              err_msg:
                type: string
                description: The error message
              request_id:
                type: string
                description: The request ID
            example:
              err_code: ASR_PAYMENT_REQUIRED
              err_msg: Project does not have enough credits for an ASR request and does not have an overage agreement.
              request_id: 123456-7890-1234-5678-901234
    insufficient_permissions:
      description: Insufficient permissions, Model not found
      content:
        application/json:
          schema:
            type: object
            properties:
              err_code:
                type: string
                description: The error code
              err_msg:
                type: string
                description: The error message
              request_id:
                type: string
                description: The request ID
            example:
              err_code: INSUFFICIENT_PERMISSIONS
              err_msg: Project does not have access to the requested model.
              request_id: 123456-7890-1234-5678-901234
    payload_too_large:
      description: Payload too large
      content:
        application/json:
          schema:
            type: object
            properties:
              err_code:
                type: string
                description: The error code
              err_msg:
                type: string
                description: The error message
              request_id:
                type: string
                description: The request ID
            example:
              err_code: Payload too large
              err_msg: Input text exceeds maximum character limit of 2000.
              request_id: 123456-7890-1234-5678-901234
    unsupported_media_type:
      description: Unsupported media type
      content:
        application/json:
          schema:
            type: object
            properties:
              err_code:
                type: string
                description: The error code
              err_msg:
                type: string
                description: The error message
              request_id:
                type: string
                description: The request ID
            example:
              err_code: UNSUPPORTED_MEDIA_TYPE
              err_msg: Content-Type header is not supported. Content-Type must be either text/plain or application/json.
              request_id: 123456-7890-1234-5678-901234
    authentication_failed:
      description: Authentication failed
      content:
        application/json:
          schema:
            type: object
            properties:
              category:
                type: string
                description: The category of the error
              message:
                type: string
                description: A message about the error
              details:
                type: string
                description: A description of the error
              request_id:
                type: string
                description: The unique identifier of the request
          example:
            category: UNAUTHORIZED
            message: Authentication failed.
            details: Check that you are using the correct credentials.
            request_id: 123456-7890-1234-5678-901234
    projects_bad_request:
      description: Project Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              category:
                type: string
                description: The error category
              message:
                type: string
                description: The error message
              details:
                type: string
                description: Additional details about the error
              request_id:
                type: string
                description: The request ID
            example:
              category: INVALID_JSON
              message: Invalid JSON submitted.
              details: 'Json deserialize error: EOF while parsing a value at line 1 column 0'
              request_id: 123456-7890-1234-5678-901234
    project_not_found:
      description: Project not found
      content:
        application/json:
          schema:
            type: object
            properties:
              category:
                type: string
                description: The category of the error
              details:
                type: string
                description: A description of the error
              message:
                type: string
                description: A message about the error
              request_id:
                type: string
                description: The unique identifier of the request
          example:
            category: NOT_FOUND
            message: A project with the submitted ID cannot be found.
            details: Check that you have submitted the intended project ID and that the project has not been deleted.
            request_id: 123456-7890-1234-5678-901234
    invalid_request:
      description: Invalid Request
      content:
        text/plain:
          schema:
            type: string
          example: 'Invalid request: scope must be either ''member'', ''admin'' or ''owner''.'
    project_unauthorized:
      description: Project Unauthorized
      content:
        text/plain:
          schema:
            type: string
          example: User does not have sufficient permissions.
    usage:
      description: Usage Summary
      content:
        application/json:
          schema:
            type: object
            properties:
              start:
                type: string
                format: date
                example: '2024-10-16'
              end:
                type: string
                format: date
                example: '2024-10-23'
              resolution:
                type: object
                properties:
                  units:
                    type: string
                    example: day
                  amount:
                    type: integer
                    example: 1
                results:
                  type: array
                  items:
                    type: object
                    properties:
                      start:
                        type: string
                        format: date
                        example: '2024-10-16'
                      end:
                        type: string
                        format: date
                        example: '2024-10-16'
                      hours:
                        type: number
                        format: float
                        example: 1097.4274322222223
                      total_hours:
                        type: number
                        format: float
                        example: 1099.3888366666667
                      requests:
                        type: integer
                        example: 425109
                      tokens:
                        type: object
                        properties:
                          in:
                            type: integer
                            example: 24770
                          out:
                            type: integer
                            example: 7521
                      tts:
                        type: object
                        properties:
                          characters:
                            type: integer
                            example: 9004185
                          requests:
                            type: integer
                            example: 23126
    fields:
      description: A list of fields for a specific project
      content:
        application/json:
          schema:
            type: object
            properties:
              tags:
                type: array
                description: List of tags associated with the project
                items:
                  type: string
                example:
                  - tag=dev
                  - tag=production
              models:
                type: array
                description: List of models available for the project.
                items:
                  type: object
                  properties:
                    name:
                      type: string
                      description: Name of the model.
                      example: 2-medical-nova
                    language:
                      type: string
                      description: The language supported by the model (IETF language tag).
                      example: en-MY
                    version:
                      type: string
                      description: Version identifier of the model, typically with a date and a revision number.
                      example: 2024-05-31.13574
                    model_id:
                      type: string
                      description: Unique identifier for the model.
                      example: 1234567890-12345-67890
              processing_methods:
                type: array
                description: Processing methods supported by the API
                items:
                  type: string
                example:
                  - sync
                  - streaming
              features:
                type: array
                description: API features available to the project
                items:
                  type: string
                example:
                  - alternatives
                  - detect_entities
                  - detect_language
    usage_breakdown:
      description: Usage breakdown response
      content:
        application/json:
          schema:
            type: object
            required:
              - start
              - end
              - resolution
              - results
            properties:
              start:
                type: string
                format: date
                description: Start date of the usage period
                example: '2025-01-16'
              end:
                type: string
                format: date
                description: End date of the usage period
                example: '2025-01-23'
              resolution:
                type: object
                required:
                  - units
                  - amount
                properties:
                  units:
                    type: string
                    description: Time unit for the resolution
                    example: day
                  amount:
                    type: integer
                    description: Amount of units
                    example: 1
              results:
                type: array
                items:
                  type: object
                  required:
                    - hours
                    - total_hours
                    - agent_hours
                    - tokens_in
                    - tokens_out
                    - tts_characters
                    - requests
                    - grouping
                  properties:
                    hours:
                      type: number
                      format: float
                      description: Audio hours processed
                      example: 1619.7242069444444
                    total_hours:
                      type: number
                      format: float
                      description: Total hours including all processing
                      example: 1621.7395791666668
                    agent_hours:
                      type: number
                      format: float
                      description: Agent hours used
                      example: 41.33564388888889
                    tokens_in:
                      type: integer
                      description: Number of input tokens
                      example: 0
                    tokens_out:
                      type: integer
                      description: Number of output tokens
                      example: 0
                    tts_characters:
                      type: integer
                      description: Number of text-to-speech characters processed
                      example: 9158866
                    requests:
                      type: integer
                      description: Number of requests
                      example: 373381
                    grouping:
                      type: object
                      properties:
                        start:
                          type: string
                          format: date
                          description: Start date for this group
                          example: '2025-01-16'
                        end:
                          type: string
                          format: date
                          description: End date for this group
                          example: '2025-01-16'
                        accessor:
                          type: string
                          nullable: true
                          description: Optional accessor identifier
                          example: '123456789012345678901234'
                        endpoint:
                          type: string
                          nullable: true
                          description: Optional endpoint identifier
                          example: listen
                        feature_set:
                          type: string
                          nullable: true
                          description: Optional feature set identifier
                          example: punctuate
                        models:
                          type: string
                          nullable: true
                          description: Optional models identifier
                          example: Nova-2
                        method:
                          type: string
                          nullable: true
                          description: Optional method identifier
                          example: async
                        tags:
                          type: string
                          nullable: true
                          description: Optional tags
                          example: tag1
                        deployment:
                          type: string
                          nullable: true
                          description: Optional deployment identifier
                          example: self-hosted
    purchases:
      description: Successful response with orders list
      content:
        application/json:
          schema:
            type: object
            properties:
              orders:
                type: array
                items:
                  type: object
                  properties:
                    order_id:
                      type: string
                      format: uuid
                      example: 025e19ba-b6d9-4a04-9f99-4fe715aca5f1
                    expiration:
                      type: string
                      format: date-time
                      example: '2026-03-04T00:00:00Z'
                    created:
                      type: string
                      format: date-time
                      example: '2023-02-21T21:13:40.014373Z'
                    amount:
                      type: number
                      format: float
                      example: 150
                    units:
                      type: string
                      example: usd
                    order_type:
                      type: string
                      example: promotional
    all_models:
      description: A list of all public models
      content:
        application/json:
          schema:
            type: object
            properties:
              stt:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                      example: general
                    canonical_name:
                      type: string
                      example: enhanced-general
                    architecture:
                      type: string
                      example: polaris
                    languages:
                      type: array
                      items:
                        type: string
                      example:
                        - en
                        - en-us
                    version:
                      type: string
                      example: 2022-05-18.1
                    uuid:
                      type: string
                      format: uuid
                      example: c7226e9e-ae1c-4057-ae2a-a71a6b0dc588
                    batch:
                      type: boolean
                      example: true
                    streaming:
                      type: boolean
                      example: true
                    formatted_output:
                      type: boolean
                      example: false
              tts:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                      example: angus
                    canonical_name:
                      type: string
                      example: aura-angus-en
                    architecture:
                      type: string
                      example: aura
                    languages:
                      type: array
                      items:
                        type: string
                      example:
                        - en
                        - en-us
                    version:
                      type: string
                      example: 2024-07-30.0
                    uuid:
                      type: string
                      format: uuid
                      example: eed36e9e-37aa-40a3-91fa-a2911e73a5da
                    metadata:
                      type: object
                      properties:
                        accent:
                          type: string
                          example: Irish
                        color:
                          type: string
                          example: '#BA80F5'
                        image:
                          type: string
                          format: uri
                          example: https://static.deepgram.com/examples/avatars/angus.jpg
                        sample:
                          type: string
                          format: uri
                          example: https://static.deepgram.com/examples/voices/angus.wav
                        tags:
                          type: array
                          items:
                            type: string
                          example:
                            - masculine
    model:
      description: A model object that can be either STT or TTS
      content:
        application/json:
          schema:
            oneOf:
              - type: object
                properties:
                  name:
                    type: string
                    example: general
                  canonical_name:
                    type: string
                    example: enhanced-general
                  architecture:
                    type: string
                    example: polaris
                  languages:
                    type: array
                    items:
                      type: string
                    example:
                      - en
                      - en-us
                  version:
                    type: string
                    example: 2022-05-18.1
                  uuid:
                    type: string
                    format: uuid
                    example: c7226e9e-ae1c-4057-ae2a-a71a6b0dc588
                  batch:
                    type: boolean
                    example: true
                  streaming:
                    type: boolean
                    example: true
                  formatted_output:
                    type: boolean
                    example: false
              - type: object
                properties:
                  name:
                    type: string
                    example: angus
                  canonical_name:
                    type: string
                    example: aura-angus-en
                  architecture:
                    type: string
                    example: aura
                  languages:
                    type: array
                    items:
                      type: string
                    example:
                      - en
                      - en-us
                  version:
                    type: string
                    example: 2024-07-30.0
                  uuid:
                    type: string
                    format: uuid
                    example: eed36e9e-37aa-40a3-91fa-a2911e73a5da
                  metadata:
                    type: object
                    properties:
                      accent:
                        type: string
                        example: Irish
                      color:
                        type: string
                        example: '#BA80F5'
                      image:
                        type: string
                        format: uri
                        example: https://static.deepgram.com/examples/avatars/angus.jpg
                      sample:
                        type: string
                        format: uri
                        example: https://static.deepgram.com/examples/voices/angus.wav
                      tags:
                        type: array
                        items:
                          type: string
                        example:
                          - masculine
    credentials:
      description: List of distribution credentials
      content:
        application/json:
          schema:
            type: object
            properties:
              distribution_credentials:
                type: array
                description: Array of distribution credentials with associated member information
                items:
                  type: object
                  required:
                    - member
                    - distribution_credentials
                  properties:
                    member:
                      type: object
                      required:
                        - member_id
                        - email
                      properties:
                        member_id:
                          type: string
                          format: uuid
                          description: Unique identifier for the member
                          example: 3376abcd-8e5e-49d3-92d4-876d3a4f0363
                        email:
                          type: string
                          format: email
                          description: Email address of the member
                          example: email@example.com
                    distribution_credentials:
                      type: object
                      required:
                        - distribution_credentials_id
                        - provider
                        - scopes
                        - created
                      properties:
                        distribution_credentials_id:
                          type: string
                          format: uuid
                          description: Unique identifier for the distribution credentials
                          example: 8b36cfd0-472f-4a21-833f-2d6343c3a2f3
                        provider:
                          type: string
                          description: The provider of the distribution service
                          example: quay
                        comment:
                          type: string
                          description: Optional comment about the credentials
                          example: My Self-Hosted Distribution Credentials
                        scopes:
                          type: array
                          description: List of permission scopes for the credentials
                          items:
                            type: string
                          example:
                            - self-hosted:product:api
                            - self-hosted:product:engine
                        created:
                          type: string
                          format: date-time
                          description: Timestamp when the credentials were created
                          example: '2023-06-28T15:36:59.609841Z'
    credential:
      description: Single distribution credential
      content:
        application/json:
          schema:
            type: object
            required:
              - member
              - distribution_credentials
            properties:
              member:
                type: object
                required:
                  - member_id
                  - email
                properties:
                  member_id:
                    type: string
                    format: uuid
                    description: Unique identifier for the member
                    example: c7b9b131-73f3-11d9-8665-0b00d2e44b83
                  email:
                    type: string
                    format: email
                    description: Email address of the member
                    example: email@example.com
              distribution_credentials:
                type: object
                required:
                  - distribution_credentials_id
                  - provider
                  - scopes
                  - created
                properties:
                  distribution_credentials_id:
                    type: string
                    format: uuid
                    description: Unique identifier for the distribution credentials
                    example: 82c32c10-53b2-4d23-993f-864b3d44502a
                  provider:
                    type: string
                    description: The provider of the distribution service
                    example: quay
                  comment:
                    type: string
                    description: Optional comment about the credentials
                    example: My Self-Hosted Distribution Credentials
                  scopes:
                    type: array
                    description: List of permission scopes for the credentials
                    items:
                      type: string
                    example:
                      - self-hosted:product:api
                      - self-hosted:product:engine
                  created:
                    type: string
                    format: date-time
                    description: Timestamp when the credentials were created
                    example: '2023-06-28T15:36:59.609841Z'