List Streams

List Streams

curl --request GET \
  --url https://streaming.lingopal.ai/v1/streams \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://streaming.lingopal.ai/v1/streams', 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://streaming.lingopal.ai/v1/streams",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://streaming.lingopal.ai/v1/streams"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://streaming.lingopal.ai/v1/streams")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

"<string>"

{
  "detail": [
    "<string>"
  ]
}

GET

streams

List Streams

curl --request GET \
  --url https://streaming.lingopal.ai/v1/streams \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://streaming.lingopal.ai/v1/streams', 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://streaming.lingopal.ai/v1/streams",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://streaming.lingopal.ai/v1/streams"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://streaming.lingopal.ai/v1/streams")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

"<string>"

{
  "detail": [
    "<string>"
  ]
}

Description

This endpoint lists all streams, with support for pagination and optional filtering by stream state. Use this to view all your active, scheduled, or completed streams. See the Quickstart guide for usage context.

Authentication

This endpoint requires an API Key.
Include your API key in the x-api-key header:

x-api-key: YOUR_API_KEY

Request

Method: GET
Endpoint: /v1/streams
Query Parameters:
- page (integer, optional, default: 1): Page number
- page_size (integer, optional, default: 10): Number of items per page
- stream_state (string, optional): Stream states are LIVE, STUCK and INIT

Response

Status: 200 OK
Content-Type: application/json

"string"

Example Usage (cURL)

curl -X GET "https://streaming.lingopal-dev.com/v1/streams?page=1&page_size=10" \
  -H "x-api-key: YOUR_API_KEY"

Authorizations

X-API-Key

string

header

required

Query Parameters

page

integer

default:1

Page number

page_size

integer

default:10

Number of items per page

stream_state

string

Stream state

Response

Successful Response

The response is of type string.

Streaming Services

Stream Client & WebSocket Services

Description

Authentication

Request

Response

Example Usage (cURL)

Authorizations

Query Parameters

Response

​Description

​Authentication

​Request

​Response

​Example Usage (cURL)

Authorizations

Query Parameters

Response

Description

Authentication

Request

Response

Example Usage (cURL)