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
      • POSTCreate a playbackId
      • DELDelete a playbackId
      • GETGet playbackId details
  • VIDEO DATA API
    • Overview
LogoLogo
StatusSupportDiscussionsLog inSign Up
LIVE STREAM APILive playback

Create a playbackId

POST
https://api.fastpix.com/v1/live/streams/:streamId/playback-ids
POST
/v1/live/streams/:streamId/playback-ids
$curl -X POST https://api.fastpix.com/v1/live/streams/8717422d89288ad5958d4a86e9afe2a2/playback-ids \
> -H "Content-Type: application/json" \
> -u "<username>:<password>" \
> -d '{
> "accessPolicy": "public"
>}'
201Created
1{
2 "success": true,
3 "data": {
4 "id": "88b7ac0f-2504-4dd5-b7b4-d84ab4fee1bd",
5 "accessPolicy": "public"
6 }
7}
Generates a new playback ID for the live stream, allowing viewers to access the stream through this ID. The playback ID can be shared with viewers for direct access to the live broadcast. By calling this endpoint with the `streamId`, FastPix returns a unique `playbackId`, which can be used to stream the live content. #### Example A media platform needs to distribute a unique playback ID to users for an exclusive live concert. The platform can also embed the stream on various partner websites.
Was this page helpful?
Previous

Delete a playbackId

Next
Built with

Generates a new playback ID for the live stream, allowing viewers to access the stream through this ID. The playback ID can be shared with viewers for direct access to the live broadcast.

By calling this endpoint with the streamId, FastPix returns a unique playbackId, which can be used to stream the live content.

Example

A media platform needs to distribute a unique playback ID to users for an exclusive live concert. The platform can also embed the stream on various partner websites.

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
After creating a new live stream, FastPix assigns a unique identifier to the stream.

Request

This endpoint expects an object.
accessPolicyenumOptionalDefaults to public
Basic access policy for media content
Allowed values:

Response

New PlaybackId created successfully
successboolean
Shows the request status. Returns true for success and false for failure.
dataobject