✨
Castmagic Docs
  • Overview
  • Quick Start
  • Authentication
  • Endpoints
    • Transcripts
  • Reference
    • Supported Formats
    • Supported Languages
    • Webhooks
Powered by GitBook
On this page
  • Submit a request to transcribe from a URL
  • Fetch details for a transcript given an identifier
  1. Endpoints

Transcripts

Transcribe audio from a URL.

PreviousAuthenticationNextSupported Formats

Last updated 2 years ago

At the core of Castmagic is transcription. Transcription is an async process and can vary in duration based on factors such as audio language, however it is typically complete in around 15 minutes or less.

Transcription supports speaker diarization by default. You will find paragraphs labled by speaker in the "utterances" key of a completed transcript response.

.

Submit a request to transcribe from a URL

POST https://app.castmagic.io/v1/transcripts

Headers

Name
Type
Description

Authorization*

String

Bearer API_SECRET

Request Body

Name
Type
Description

url*

String

URL of file to transcribe

boosted_words

String[]

List of words to boost when transcribing

language_code

String

Language code. Defaults to "en". See Supported Languages section for all language codes

language_detection

Boolean

Attempt to automatically detect the content language. Will be overridden by language_code if included

{
    "id": "ae844ebc-ad12-444e-8310-1049a12cf139",
    "status": "queued"
}
{
    "errors": {
        "url": [
            "must be a valid url"
        ]
    },
    "valid": false       
}

Fetch details for a transcript given an identifier

GET https://app.castmagic.io/v1/transcripts/:id

Path Parameters

Name
Type
Description

id*

String

ID of the transcript to get

Headers

Name
Type
Description

Authorization*

String

Bearer API_SECRET

{
    "id": "ae844ebc-ad12-444e-8310-1049a12cf139",
    "status": "processing"
}
{
    "id": "ae844ebc-ad12-444e-8310-1049a12cf139",
    "status": "error",
    "error": "Video to audio conversion error, could not transcode from video/mp4"
}
{
    "id": "ae844ebc-ad12-444e-8310-1049a12cf139",
    "status": "completed",
    "audio_duration": 3600,
    "utterances": [...]
}
See a sample of a full transcript JSON