LiveStreams

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/api-video/json-schema/api-video-live-stream-list-response-schema.json",
  "title": "LiveStreams",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/api-video-live-streams-api-openapi.yml#/components/schemas/live-stream-list-response",
  "required": [
    "data",
    "pagination"
  ],
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/live-stream"
      }
    },
    "pagination": {
      "$ref": "#/$defs/pagination"
    }
  },
  "$defs": {
    "live-stream": {
      "title": "LiveStream",
      "type": "object",
      "properties": {
        "liveStreamId": {
          "type": "string",
          "description": "The unique identifier for the live stream. Live stream IDs begin with \"li.\""
        },
        "name": {
          "type": "string",
          "description": "The name of your live stream."
        },
        "streamKey": {
          "type": "string",
          "description": "The unique, private stream key that you use to begin streaming."
        },
        "public": {
          "type": "boolean",
          "description": "Whether your video can be viewed by everyone, or requires authentication to see it. A setting of false will require a unique token for each view. Learn more about the Private Video feature [here](https://docs.api.video/delivery/video-privacy-access-management)."
        },
        "assets": {
          "$ref": "#/$defs/live-stream-assets"
        },
        "playerId": {
          "type": "string",
          "description": "The unique identifier for the player."
        },
        "broadcasting": {
          "type": "boolean",
          "description": "Whether or not you are broadcasting the live video you recorded for others to see. True means you are broadcasting to viewers, false means you are not."
        },
        "restreams": {
          "description": "Returns the list of restream destinations.",
          "type": "array",
          "items": {
            "$ref": "#/$defs/restreams-response-object"
          }
        },
        "createdAt": {
          "type": "string",
          "description": "When the player was created, presented in ATOM UTC format.",
          "format": "date-time"
        },
        "updatedAt": {
          "type": "string",
          "description": "When the player was last updated, presented in ATOM UTC format.",
          "format": "date-time"
        }
      },
      "required": [
        "liveStreamId",
        "restreams"
      ]
    },
    "live-stream-assets": {
      "title": "LiveStreamAssets",
      "type": "object",
      "properties": {
        "hls": {
          "type": "string",
          "description": "The http live streaming (HLS) link for your live video stream.",
          "format": "uri"
        },
        "iframe": {
          "type": "string",
          "description": "The embed code for the iframe containing your live video stream."
        },
        "player": {
          "type": "string",
          "description": "A link to the video player that is playing your live stream.",
          "format": "uri"
        },
        "thumbnail": {
          "type": "string",
          "description": "A link to the thumbnail for your video.",
          "format": "uri"
        }
      }
    },
    "pagination": {
      "title": "Pagination",
      "required": [
        "links"
      ],
      "type": "object",
      "properties": {
        "itemsTotal": {
          "type": "integer",
          "description": "Total number of items that exist.",
          "readOnly": true
        },
        "pagesTotal": {
          "type": "integer",
          "description": "Number of items listed in the current page.",
          "readOnly": true
        },
        "pageSize": {
          "type": "integer",
          "description": "Maximum number of item per page.",
          "readOnly": true
        },
        "currentPage": {
          "type": "integer",
          "description": "The current page index.",
          "readOnly": true
        },
        "currentPageItems": {
          "type": "integer",
          "description": "The number of items on the current page.",
          "readOnly": true
        },
        "links": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/pagination-link"
          }
        }
      }
    },
    "pagination-link": {
      "title": "PaginationLink",
      "type": "object",
      "properties": {
        "rel": {
          "type": "string"
        },
        "uri": {
          "type": "string",
          "format": "uri"
        }
      }
    },
    "restreams-response-object": {
      "title": "Restreams response object",
      "type": "object",
      "properties": {
        "name": {
          "description": "Returns the name of a restream destination.",
          "type": "string"
        },
        "serverUrl": {
          "description": "Returns the server URL of a restream destination.",
          "type": "string"
        },
        "streamKey": {
          "description": "Returns the unique key of the live stream that is set up for restreaming.",
          "type": "string"
        }
      }
    }
  }
}