Add an event to a schedule channel

POST

https://api.fastpix.com/v1/cloud-playout/channels/:id/schedule-event

POST

/v1/cloud-playout/channels/:id/schedule-event

curl -X POST https://api.fastpix.com/v1/cloud-playout/channels/cc99cae6-56b4-46ab-9f4a-8b2462d8137c/schedule-event \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d '{
  "event": {
    "type": "vod",
    "startTime": "2026-09-02T18:00:00",
    "referenceId": "8c2c4ef1-1c2a-4a49-9c5b-8f9c0a7c3d21"
  }
}'

201Created

{
  "success": true,
  "data": [
    {
      "id": "b1d6f0a7-4e28-4b93-90c5-7f2a8c1d3e64",
      "channelId": "cc99cae6-56b4-46ab-9f4a-8b2462d8137c",
      "type": "vod",
      "referenceId": "8c2c4ef1-1c2a-4a49-9c5b-8f9c0a7c3d21",
      "name": "Morning headlines",
      "startTime": "2026-09-02T18:00:00Z",
      "endTime": "2026-09-02T18:10:30Z",
      "duration": "00:10:30",
      "sourceResolution": "1080p",
      "thumbnail": "https://images.fastpix.com/8c2c4ef1-1c2a-4a49-9c5b-8f9c0a7c3d21/thumbnail.png",
      "segments": [],
      "createdAt": "2026-08-20T09:02:11.114530Z",
      "updatedAt": "2026-08-20T09:02:11.114530Z"
    },
    {
      "id": "3e5c7a90-8b2d-4f61-9c07-6d4a1b8e2f53",
      "channelId": "cc99cae6-56b4-46ab-9f4a-8b2462d8137c",
      "type": "live",
      "name": "Evening press conference",
      "startTime": "2026-09-02T19:00:00Z",
      "endTime": "2026-09-02T20:00:00Z",
      "duration": "01:00:00",
      "sourceResolution": "1080p",
      "segments": [],
      "createdAt": "2026-08-20T09:05:44.210338Z",
      "updatedAt": "2026-08-20T09:05:44.210338Z"
    }
  ]
}

This endpoint schedules content on a Cloud Playout schedule channel. Unlike a loop channel, which repeats its programs, a schedule channel plays what you place on its timeline at the time you place it. The id in the path is the channel’s ID.

How it works

Make a POST request to this endpoint with an event object describing what to play and when it starts.
What else you send depends on the type:
- vod plays one media item. Send its referenceId and leave endTime and name out, because the event ends when the media does.
- playlist plays every item in a playlist back to back. Send the playlist’s referenceId and leave endTime and name out.
- live reserves a slot for the channel’s live input. Send endTime and a name, and leave referenceId out. The slot must be at least 5 minutes long.
The response returns the events that were created. A playlist becomes one event per item in it, laid end to end from startTime.

The event must sit inside the channel’s own start and end times, and it cannot overlap an event that is already scheduled. Media used by a vod event must have reached the ready status. On a channel that is on air, an event cannot be added if it would start or end in the next few minutes.

Example

A news channel schedules a recorded bulletin at 18:00, then reserves a live slot from 19:00 to 20:00 for a press conference.

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

idstringRequiredformat: "uuid"

The unique identifier of the schedule channel the event is added to.

Request

This endpoint expects an object.

eventobjectRequired

Response

Event added to the schedule channel successfully

successbooleanOptional

Shows the request status. Returns true for success and false for failure.

datalist of objectsOptional

The events on the channel, in the order they play.