Getting reader-friendly transcripts (paragraphs and sentences)

    You can use either of the following endpoints to retrieve a completed transcript automatically broken down into paragraphs or sentences. Using these endpoints, the API will attempt to semantically segment your transcript into paragraphs/sentences to create more reader-friendly transcripts.

    GET Request to Retrieve a Completed Transcript

    The transcript must be completed before making this request. Once your transcript has a "completed" status you can hit this endpoint to retrieve either paragraphs or sentences. More on that here!

    Here are some code examples that show how to get your transcript with the paragraphs endpoint.

    To hit the sentences endpoint, simply replace "paragraphs" with "sentences" after your transcript id.

    JSON Response

    the API will respond with a list of paragraphs (or sentences, depending on the API endpoint you used).

    {
       "paragraphs":[
          {
             "text":"Hello. I'm Sunny Williams. I'm up here on the International Space Station. So this is No two. This is a really cool module.",
             "start":770,
             "end":10710,
             "confidence":0.97,
             "words":[
                {"text": "Hello.", "start": 100, "end": 1000, "confidence": 0.99},
                "..."
             ]
          },
          {
             "text":"Of course, most of these modules, you'll see, they have four sides and they're put together that way we could sort of work on a flat plane, either a wall, a floor, another wall, or the ceiling. But again, all you have to do is turn yourself and your reference changes. The reason I'm bringing that up is because this is where four out of six of us sleep. And so people always ask about sleeping in space. Do you lie down?",
             "start":11370,
             "end":39060,
             "confidence":0.99,
             "words":[
                {"text": "Of.", "start": 12, "end": 450, "confidence": 0.99},
                "..."
             ]
          },
          {
             "text":"Are you in a bed? Not really, because it doesn't matter. You don't really have the sensation of lying down. You just sit in your sleeping bag. So Here's one sleep station right here.",
             "start":39070,
             "end":50250,
             "confidence":0.99,
             "words":[
                {"text": "Are.", "start": 45, "end": 290, "confidence": 0.99},
                "..."
             ]
          },
    
            "......"
    
        ],
        "id": "3otc28umy-25ae-4446-b133-70e244be5208",
        "confidence": 0.951530612244907,
        "audio_duration": 521.352
    }