Skip to main content
POST
/
api
/
live
/
start-session
Start live session
curl --request POST \
  --url https://api-prod.nomadicml.com/api/live/start-session \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'source_url=<string>' \
  --data 'name=<string>' \
  --data 'stream_id=<string>' \
  --data 'rapid_review_query=<string>'
import requests

url = "https://api-prod.nomadicml.com/api/live/start-session"

payload = {
    "source_url": "<string>",
    "name": "<string>",
    "stream_id": "<string>",
    "rapid_review_query": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/x-www-form-urlencoded"
}

response = requests.post(url, data=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/x-www-form-urlencoded'
  },
  body: new URLSearchParams({
    source_url: '<string>',
    name: '<string>',
    stream_id: '<string>',
    rapid_review_query: '<string>'
  })
};

fetch('https://api-prod.nomadicml.com/api/live/start-session', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-prod.nomadicml.com/api/live/start-session",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "source_url=%3Cstring%3E&name=%3Cstring%3E&stream_id=%3Cstring%3E&rapid_review_query=%3Cstring%3E",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/x-www-form-urlencoded"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-prod.nomadicml.com/api/live/start-session"

	payload := strings.NewReader("source_url=%3Cstring%3E&name=%3Cstring%3E&stream_id=%3Cstring%3E&rapid_review_query=%3Cstring%3E")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/x-www-form-urlencoded")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api-prod.nomadicml.com/api/live/start-session")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/x-www-form-urlencoded")
  .body("source_url=%3Cstring%3E&name=%3Cstring%3E&stream_id=%3Cstring%3E&rapid_review_query=%3Cstring%3E")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api-prod.nomadicml.com/api/live/start-session")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/x-www-form-urlencoded'
request.body = "source_url=%3Cstring%3E&name=%3Cstring%3E&stream_id=%3Cstring%3E&rapid_review_query=%3Cstring%3E"

response = http.request(request)
puts response.read_body
{
  "session_id": "<string>",
  "stream_id": "<string>",
  "status": "<string>"
}
{
  "detail": "<string>",
  "message": "<string>",
  "error": "<string>"
}
{
  "detail": "<string>",
  "message": "<string>",
  "error": "<string>"
}
{
  "detail": "<string>",
  "message": "<string>",
  "error": "<string>"
}
{
  "detail": "<string>",
  "message": "<string>",
  "error": "<string>"
}
{
  "detail": "<string>",
  "message": "<string>",
  "error": "<string>"
}
{
  "detail": "<string>",
  "message": "<string>",
  "error": "<string>"
}

Authorizations

Authorization
string
header
required

Use Authorization: Bearer <NOMADIC_API_KEY>.

Body

application/x-www-form-urlencoded
source_url
string
required
name
string
required
stream_id
string
rapid_review_query
string

Response

Successful response.

session_id
string
stream_id
string
status
string