For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
StatusSupportDiscussionsLog inSign Up
Docs HomeAPI ReferenceVideo on DemandAI FeaturesLive StreamingVideo PlayerVideo DataCloud PlayoutRecipes
Docs HomeAPI ReferenceVideo on DemandAI FeaturesLive StreamingVideo PlayerVideo DataCloud PlayoutRecipes
  • ACTIVATE ACCOUNT
    • Create account
  • PRODUCT OS API
    • Overview
  • ERROR CODES
    • Error codes
  • VIDEO ON DEMAND API
    • Overview
  • LIVE STREAM API
    • Overview
      • GETGet all live streams
      • GETGet stream views by ID
      • GETGet stream by ID
      • DELDelete a stream
      • PATCHUpdate a stream
      • PUTEnable a stream
      • PUTDisable a stream
      • PUTComplete a stream
  • VIDEO DATA API
    • Overview
LogoLogo
StatusSupportDiscussionsLog inSign Up
LIVE STREAM APIManage live stream

Get stream by ID

GET
https://api.fastpix.com/v1/live/streams/:streamId
GET
/v1/live/streams/:streamId
$curl https://api.fastpix.com/v1/live/streams/61a264dcc447b63da6fb79ef925cd76d \
>     -u "<username>:<password>"
200Retrieved
1{
2  "success": true,
3  "data": {
4    "streamId": "fa7f8c0950ea48ebcc5ef9de8c23deaa",
5    "streamKey": "3dc5d7641f918baa083a5c52a5bd9cbckfa7f8c0950ea48ebcc5ef9de8c23deaa",
6    "srtSecret": "c51739512d0088d98a46925c9b74c73akfa7f8c0950ea48ebcc5ef9de8c23deaa",
7    "trial": false,
8    "status": "idle",
9    "maxResolution": "1080p",
10    "maxDuration": 28800,
11    "createdAt": "2024-10-15T08:48:31.551351Z",
12    "reconnectWindow": 60,
13    "enableRecording": true,
14    "enableDvrMode": false,
15    "mediaPolicy": "public",
16    "metadata": {
17      "livestream_name": "fastpix_livestream"
18    },
19    "lowLatency": true,
20    "closedCaptions": false,
21    "playbackIds": [
22      {
23        "id": "4e43ec52-4775-4f68-a3ff-a57d8a59bba8",
24        "accessPolicy": "public"
25      }
26    ],
27    "mediaIds": [
28      "03cdf35d-8626-4b5f-bd14-d2212cd2a991"
29    ],
30    "srtPlaybackResponse": {
31      "srtPlaybackStreamId": "playfa7f8c0950ea48ebcc5ef9de8c23deaa",
32      "srtPlaybackSecret": "490e707dd4d165c9e38d261b252f9457kfa7f8c0950ea48ebcc5ef9de8c23deaa"
33    }
34  }
35}
This endpoint retrieves details about a specific live stream by its unique `streamId`. It includes data such as the stream’s `status` (idle, preparing, active, disabled), `metadata` (title, description), and more. #### Example Suppose a news agency is broadcasting a live event and wants to track the configurations set for the live stream while also checking the stream's status. Related guide: <a href="https://docs.fastpix.io/docs/manage-streams">Manage streams</a>
Was this page helpful?
Previous

Delete a stream

Next
Built with

This endpoint retrieves details about a specific live stream by its unique streamId. It includes data such as the stream’s status (idle, preparing, active, disabled), metadata (title, description), and more.

Example

Suppose a news agency is broadcasting a live event and wants to track the configurations set for the live stream while also checking the stream’s status.

Related guide: Manage streams

Authentication

AuthorizationBasic

FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request.

  • Username: Access Token ID
  • Password: Secret Key

Activate your FastPix account to generate your API credentials. See the guide here

Path parameters

streamIdstringRequired
Upon creating a new live stream, FastPix assigns a unique identifier to the stream.

Response

Stream details retrieved successfully
successboolean
Shows the request status. Returns true for success and false for failure.
dataobject
Displays the result of the request.