Stop Stream By Uuid

curl --request POST \
  --url https://streaming.lingopal.ai/v1/streams/{stream_id}/stop \
  --header 'X-API-Key: <api-key>'

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

fetch('https://streaming.lingopal.ai/v1/streams/{stream_id}/stop', 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/{stream_id}/stop",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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/{stream_id}/stop"

	req, _ := http.NewRequest("POST", 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/{stream_id}/stop")

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

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

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

"<string>"

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

POST

streams

{stream_id}

stop

Stop Stream By Uuid

curl --request POST \
  --url https://streaming.lingopal.ai/v1/streams/{stream_id}/stop \
  --header 'X-API-Key: <api-key>'

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

fetch('https://streaming.lingopal.ai/v1/streams/{stream_id}/stop', 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/{stream_id}/stop",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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/{stream_id}/stop"

	req, _ := http.NewRequest("POST", 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/{stream_id}/stop")

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

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

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

"<string>"

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Description

This endpoint stops a running stream by its stream_id. Use this to end a live stream when it is no longer needed. 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: POST
Endpoint: /v1/streams/{stream_id}/stop
Path Parameter:
- stream_id (string, required): Stream ID

Response

Status: 200 OK
Content-Type: application/json

"string"

Example Usage (cURL)

curl -X POST "https://streaming.lingopal-dev.com/v1/streams/your-stream-id/stop" \
  -H "x-api-key: YOUR_API_KEY"

Authorizations

X-API-Key

string

header

required

Path Parameters

stream_id

string

required

Stream ID

Response

Successful Response

The response is of type string.

Streaming Services

Stream Client & WebSocket Services

Stop Stream By Uuid

Description

Authentication

Request

Response

Example Usage (cURL)

Authorizations

Path Parameters

Response

​Description

​Authentication

​Request

​Response

​Example Usage (cURL)

Authorizations

Path Parameters

Response

Description

Authentication

Request

Response

Example Usage (cURL)