LiveStreamCreationPayload

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/api-video/json-schema/api-video-live-stream-creation-payload-schema.json",
  "title": "LiveStreamCreationPayload",
  "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-creation-payload",
  "required": [
    "name"
  ],
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Add a name for your live stream here."
    },
    "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)."
    },
    "playerId": {
      "type": "string",
      "description": "The unique identifier for the player."
    },
    "restreams": {
      "description": "Use this parameter to add, edit, or remove `RTMPS` or `RTMP` services where you want to restream a live stream. The list can only contain up to 5 destinations.",
      "maxItems": 5,
      "type": "array",
      "items": {
        "$ref": "#/$defs/restreams-request-object"
      }
    }
  },
  "$defs": {
    "restreams-request-object": {
      "title": "Restreams request object",
      "description": "Adding restream destinations is optional. However, if you set a restream destination, you must provide all attributes for each destination.",
      "type": "object",
      "required": [
        "name",
        "serverUrl",
        "streamKey"
      ],
      "properties": {
        "name": {
          "description": "Use this parameter to define a name for the restream destination.",
          "type": "string"
        },
        "serverUrl": {
          "description": "Use this parameter to set the `RTMPS` or `RTMP` server URL of the restream destination.",
          "type": "string"
        },
        "streamKey": {
          "description": "Use this parameter to provide the unique key of the live stream that you want to restream.",
          "type": "string"
        }
      }
    }
  }
}