Skip to content

Creating a Livestream

The API exposes a set of endpoints to create and manage livestreams. This guide will help you get started with the basics of creating a livestream with the API.

  1. Create a new livestream. There are a wide array of options available. A full set of options can be found in the reference guide. For the transcription, please check this reference.
    mutation {
    createLivestream(
    timezone: "Europe/Berlin"
    attributes: {
    startsAt: "2025-02-13T12:00:00Z"
    becomesVod: true
    chatEnabled: true
    duration: 3600
    expectedVisitors: 100
    hlsOutput: true
    transcription: {
    transcribeEditor: true
    transcribeEngine: VIDEO_TAXI
    transcribeEditorExpiry: 30
    transcribeLanguage: "de"
    transcribeLiveTranslationLanguages: ["en-US"]
    }
    name: "API Test Livestream"
    quality: FHD
    ppv: false
    passwordEnabled: false
    publicStreaming: true
    }
    ) {
    id
    embedUrl
    streamUrl
    }
    }
  2. Retrieve the embed URL and stream URL to start the livestream. If you discarded the result of the mutation, you can retrieve the URLs with the following query:
    query {
    livestream(id: "<ID>") {
    embedUrl
    streamUrl
    }
    }
    The embedUrl can be used to embed the livestream on your website. The streamUrl is the URL to the HLS stream.