StreamYard · Schema

StreamYard Broadcast

Represents a live streaming or recording session in StreamYard. Broadcasts can simultaneously stream to multiple platforms.

BroadcastingLive StreamingMultistreamingRecordingsVideo

Properties

Name Type Description
id string The unique identifier of the broadcast
title string The title of the broadcast
description stringnull Optional description of the broadcast
status string Current broadcast status
type string Whether this is a live stream or recording session
scheduledAt stringnull Scheduled start time (ISO 8601)
startedAt stringnull Actual start time
endedAt stringnull Time the broadcast ended
studioUrl string URL to join the broadcast studio
guestUrl stringnull Shareable URL for guests to join
createdAt string When the broadcast was created
destinations array Streaming destinations for this broadcast
View JSON Schema on GitHub

JSON Schema

streamyard-broadcast-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://developers.streamyard.com/schemas/broadcast.json",
  "title": "StreamYard Broadcast",
  "description": "Represents a live streaming or recording session in StreamYard. Broadcasts can simultaneously stream to multiple platforms.",
  "type": "object",
  "required": ["id", "title", "status"],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier of the broadcast"
    },
    "title": {
      "type": "string",
      "description": "The title of the broadcast"
    },
    "description": {
      "type": ["string", "null"],
      "description": "Optional description of the broadcast"
    },
    "status": {
      "type": "string",
      "enum": ["created", "live", "completed", "cancelled"],
      "description": "Current broadcast status"
    },
    "type": {
      "type": "string",
      "enum": ["live", "recording"],
      "description": "Whether this is a live stream or recording session"
    },
    "scheduledAt": {
      "type": ["string", "null"],
      "format": "date-time",
      "description": "Scheduled start time (ISO 8601)"
    },
    "startedAt": {
      "type": ["string", "null"],
      "format": "date-time",
      "description": "Actual start time"
    },
    "endedAt": {
      "type": ["string", "null"],
      "format": "date-time",
      "description": "Time the broadcast ended"
    },
    "studioUrl": {
      "type": "string",
      "format": "uri",
      "description": "URL to join the broadcast studio"
    },
    "guestUrl": {
      "type": ["string", "null"],
      "format": "uri",
      "description": "Shareable URL for guests to join"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "When the broadcast was created"
    },
    "destinations": {
      "type": "array",
      "description": "Streaming destinations for this broadcast",
      "items": {
        "$ref": "#/$defs/BroadcastDestination"
      }
    }
  },
  "$defs": {
    "BroadcastDestination": {
      "type": "object",
      "properties": {
        "id": {"type": "string"},
        "platform": {
          "type": "string",
          "enum": ["youtube", "facebook", "linkedin", "twitter", "twitch", "rtmp"]
        },
        "status": {
          "type": "string",
          "enum": ["pending", "live", "completed", "error"]
        },
        "viewerCount": {"type": ["integer", "null"]},
        "streamUrl": {"type": ["string", "null"], "format": "uri"}
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/streamyard-broadcast"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.