v3

latestOpenAPI 3.0.32026-07-31112307733.3 KB
transcript

List Transcript

The base rate limit for this endpoint is:

  • 60 requests per min per workspace
get/api/v1/transcript/

Query parameters

created_at_afterstring date-time
created_at_beforestring date-time
cursorstring

The pagination cursor value.

recording_idstring uuid
status_code'done' | 'failed' | 'processing'
  • processing - Processing
  • done - Done
  • failed - Failed

Response

nextstring nullable
previousstring nullable

Example response

{
  "results": [
    {
      "provider": {
        "assembly_ai_async": {
          "speech_model": null,
          "language_code": "en_us",
          "language_detection": true,
          "language_confidence_threshold": 0.7,
          "punctuate": true,
          "format_text": true,
          "multichannel": true,
          "webhook_url": "https://your-webhook-url.tld/path",
          "webhook_auth_header_name": "webhook-secret",
          "webhook_auth_header_value": "webhook-secret-value",
          "auto_highlights": true,
          "audio_start_from": 10,
          "audio_end_at": 280,
          "filter_profanity": true,
          "redact_pii": true,
          "redact_pii_audio": true,
          "redact_pii_audio_quality": "mp3",
          "redact_pii_policies": [
            "us_social_security_number",
            "credit_card_number"
          ],
          "redact_pii_sub": "hash",
          "speaker_labels": true,
          "speakers_expected": 2,
          "content_safety": true,
          "iab_categories": true,
          "custom_spelling": [],
          "disfluencies": false,
          "sentiment_analysis": true,
          "auto_chapters": true,
          "entity_detection": true,
          "speech_threshold": 0.5,
          "summarization": true,
          "summary_model": "informative",
          "summary_type": "bullets",
          "custom_topics": true,
          "topics": [],
          "speech_understanding": {
            "request": {
              "translation": {
                "target_languages": [
                  "es",
                  "de"
                ],
                "formal": true,
                "match_original_utterance": true
              }
            }
          }
        },
        "gladia_v2_async": {
          "custom_vocabulary_config": {
            "vocabulary": [
              "Westeros",
              {
                "value": "Stark"
              },
              {
                "value": "Night's Watch",
                "pronunciations": [
                  "Nightz Watch"
                ],
                "intensity": 0.4,
                "language": "en"
              }
            ],
            "default_intensity": 0.5
          },
          "callback_url": "http://callback.example",
          "callback_config": {
            "url": "http://callback.example"
          },
          "subtitles_config": {
            "formats": [
              "srt"
            ]
          },
          "diarization_config": {
            "number_of_speakers": 3,
            "min_speakers": 1,
            "max_speakers": 2
          },
          "translation_config": {
            "target_languages": [
              "en"
            ]
          },
          "custom_spelling_config": {
            "spelling_dictionary": {
              "Gettleman": [
                "gettleman"
              ],
              "SQL": [
                "Sequel"
              ]
            }
          },
          "structured_data_extraction_config": {
            "classes": [
              "Persons",
              "Organizations"
            ]
          },
          "audio_to_llm_config": {
            "prompts": [
              "Extract the key points from the transcription"
            ]
          }
        },
        "speechmatics_async": {
          "alignment_config": {
            "language": "en"
          },
          "transcription_config": {
            "language": "en",
            "output_locale": "en-GB",
            "additional_vocab": [
              {
                "content": "Speechmatics",
                "sounds_like": [
                  "speechmatics"
                ]
              },
              {
                "content": "gnocchi",
                "sounds_like": [
                  "nyohki",
                  "nokey",
                  "nochi"
                ]
              },
              {
                "content": "CEO",
                "sounds_like": [
                  "C.E.O."
                ]
              },
              {
                "content": "financial crisis"
              }
            ],
            "diarization": "channel",
            "channel_diarization_labels": [
              "Caller",
              "Agent"
            ]
          },
          "tracking": {
            "title": "ACME Q12018 Earnings Call",
            "reference": "/data/clients/ACME/statements/segs/2018Q1-seg8",
            "tags": [
              "quick-review",
              "segment"
            ],
            "details": {
              "client": "ACME Corp",
              "segment": 8,
              "seg_start": 963.201,
              "seg_end": 1091.481
            }
          }
        },
        "assembly_ai_async_chunked": {
          "speech_model": null,
          "language_code": "en_us",
          "language_detection": true,
          "language_confidence_threshold": 0.7,
          "punctuate": true,
          "format_text": true,
          "multichannel": true,
          "webhook_url": "https://your-webhook-url.tld/path",
          "webhook_auth_header_name": "webhook-secret",
          "webhook_auth_header_value": "webhook-secret-value",
          "auto_highlights": true,
          "audio_start_from": 10,
          "audio_end_at": 280,
          "filter_profanity": true,
          "redact_pii": true,
          "redact_pii_audio": true,
          "redact_pii_audio_quality": "mp3",
          "redact_pii_policies": [
            "us_social_security_number",
            "credit_card_number"
          ],
          "redact_pii_sub": "hash",
          "speaker_labels": true,
          "speakers_expected": 2,
          "content_safety": true,
          "iab_categories": true,
          "custom_spelling": [],
          "disfluencies": false,
          "sentiment_analysis": true,
          "auto_chapters": true,
          "entity_detection": true,
          "speech_threshold": 0.5,
          "summarization": true,
          "summary_model": "informative",
          "summary_type": "bullets",
          "custom_topics": true,
          "topics": [],
          "speech_understanding": {
            "request": {
              "translation": {
                "target_languages": [
                  "es",
                  "de"
                ],
                "formal": true,
                "match_original_utterance": true
              }
            }
          }
        },
        "gladia_v2_streaming": {
          "custom_metadata": {
            "user": "John Doe"
          },
          "realtime_processing": {
            "custom_vocabulary_config": {
              "vocabulary": [
                "Westeros",
                {
                  "value": "Stark"
                },
                {
                  "value": "Night's Watch",
                  "pronunciations": [
                    "Nightz Watch"
                  ],
                  "intensity": 0.4,
                  "language": "en"
                }
              ],
              "default_intensity": 0.5
            },
            "custom_spelling_config": {
              "spelling_dictionary": {
                "Gettleman": [
                  "gettleman"
                ],
                "SQL": [
                  "Sequel"
                ]
              }
            },
            "translation_config": {
              "target_languages": [
                "en"
              ]
            }
          },
          "callback_config": {
            "url": "https://callback.example"
          }
        }
      }
    }
  ]
}