DEdeepdub-ai
Issues

Create a new issue

Changed on

Report a problem with a TTS generation by creating a new issue. Issues are tracked internally by the Deepdub team and used to improve voice quality. The problemAudioFile field can optionally include base64-encoded audio attached to the issue, and problemSeconds indicates the timestamp in the audio where the problem appears.

post/issues

Request

  • Base URL
    https://restapi.deepdub.ai/api/v1
  • Auth
    API key in header x-api-key

Headers

x-api-keystring required

API Key

Request body

generationIdstring required

ID of the generation that has the problem

generatedTextstring required

Text that was passed to the TTS endpoint

problemWordstring required

Word (or phrase) that was generated incorrectly

voicePromptIdstring required

ID of the voice prompt used in the generation

type'hallucinations' | 'glossary'

Category of problem being reported. Omit to default to hallucinations. Any other value returns 400.

additionalCommentsstring

Free-form comments describing the problem

problemAudioFilestring

Optional base64-encoded audio clip to attach to the issue

problemSecondsnumber

Seconds in the audio where the problem appears

phoneticHeardstring

Optional phonetic transcription of how the word actually sounded

phoneticExpectedstring

Optional phonetic transcription of how the word should sound

modelstring

Model used for the generation. Optional — omit it if you don't know which model produced the audio. Up to 64 characters of letters, digits, ., _, :, / or -; any other value returns 400. Recorded as reported and not validated against the list of available models.

Example request

{
  "generationId": "abc123-def456",
  "generatedText": "Hello world, welcome to Deepdub.",
  "problemWord": "Deepdub",
  "voicePromptId": "bd1b00bb-be1c-4679-8eaa-0fcbfd4ff773",
  "type": "hallucinations",
  "additionalComments": "Mispronunciation of brand name",
  "problemSeconds": 2.5,
  "phoneticHeard": "deep-dubb",
  "phoneticExpected": "deep-dub",
  "model": "dd-etts-3.0"
}

Response

Issue created

idstring
state'open' | 'uploaded_for_correction' | 'in_progress' | 'resolved' | 'rejected'

Current state of the issue.

rejectionReasonstring

Why the issue was rejected. Present only when state is rejected.

createdAtstring date-time
updatedAtstring date-time
generationIdstring
voicePromptIdstring
type'hallucinations' | 'glossary'

Category of problem being reported.

localestring

Locale of the reported generation, when known.

modelstring

Model reported for the generation. Present only when it was supplied on create or update.

problemSecondsnumber
phoneticHeardstring

Phonetic transcription of how the word actually sounded

phoneticExpectedstring

Phonetic transcription of how the word should sound

Example response

{
  "id": "iss_12345abcde",
  "state": "open",
  "rejectionReason": "duplicate report",
  "locale": "en-US",
  "model": "dd-etts-3.0"
}

Changes

  • 5b7797f462f6Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

  • 9f61d10fc15eRevision changes
    • warning

      added the new in_progress enum value to the response property for the response status

    • warning

      added the new open enum value to the response property for the response status

    • warning

      added the new rejected enum value to the response property for the response status

    • warning

      added the new resolved enum value to the response property for the response status

    • warning

      added the new uploaded_for_correction enum value to the response property for the response status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status