Get a live video

URL

GET https://api.complycube.com/v1/liveVideos/:id

Retrieves an existing live video.

Headers

Name	Type	Description
Authorization*	string	The live or sandbox API key.

Path parameters

Name	Type	Description
id*	string	The ID of the live video.

Example request

cURL

curl -X GET https://api.complycube.com/v1/liveVideos/{:liveVideoId} \
     -H 'Authorization: <YOUR_API_KEY>'

Node.js

const { ComplyCube } = require("@complycube/api");

const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });

const liveVideo = await complycube.liveVideo.get("LIVE_VIDEO_ID");

Python

from complycube import ComplyCubeClient

cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')

livevideo = ccapi.livevideos.get(videoid)

PHP

use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR_API_KEY>');

$liveVideo = $ccapi->livevideos()->get('LIVE_VIDEO_ID');

.NET

using ComplyCube.Net;
using ComplyCube.Net.Resources.Clients;

var liveVideoApi = new LiveVideoApi(new ComplyCubeClient("<YOUR_API_KEY>"));

var liveVideo = liveVideoApi.GetAsync("LIVE_VIDEO_ID").Result;

Example responses

Success (200)

{
    "id": "5eb1b5f231778a0008d1c3f6",
    "clientId": "5eb1276d96be4a0008713af5",
    "language": "en-GB",
    "challenges": [
      {
        "type": "voice",
        "value": [
          "7",
          "9",
          "1",
          "7"
        ]
      },
      {
        "type": "actions",
        "value": [
          "turnHeadLeft"
        ]
      }
    ],
    "createdAt": "2020-01-01T14:06:44.756Z",
    "updatedAt": "2020-01-01T14:06:44.756Z"
}

Resource Not Found (404)

{
    "type": "resource_not_found",
    "message": "Invalid live video id '5eb1b5f231778a0008d1c3f5'"
}