Быстрый старт

Выпустите ключСкопировать ссылку на раздел

Откройте раздел «API» панели и нажмите «Выпустить ключ». Укажите:

• Название — по нему ключ узнают в списке и в уведомлениях о нём.
• Права. Для этого руководства отметьте «Каналы и их настройки» и «Запуски зрителей». Чтение доступно любому ключу.
• Срок и, если запросы будут приходить с известных адресов, разрешённые адреса.

Выпуск подтверждается кодом из письма. Ключ показывается один раз: скопируйте его и сохраните в хранилище секретов вашего сервера. Позже его не увидит никто, в том числе поддержка.

Ключ выглядит так: sky_ и 43 латинские буквы и цифры.

Проверьте ключСкопировать ссылку на раздел

Сохраните ключ в переменной окружения и запросите состояние аккаунта:

export API_KEY="sky_..."

curl https://api.skystream.su/app/v1/account \  -H "Authorization: Bearer $API_KEY"

Ответ содержит срок лимита, пулы зрителей по площадкам, баланс и сведения о ключе:

{  "limit": {    "status": "active",    "expires_at": "2026-12-31T21:00:00.000Z"  },  "max_channels": 5,  "channel_count": 0,  "max_graphs": 10,  "graph_count": 0,  "balance": {    "amount": 150000,    "currency": "RUB"  },  "pools": {    "twitch": {      "size": 400,      "busy": 0,      "free": 400,      "configured": 0    },    "kick": {      "size": 0,      "busy": 0,      "free": 0,      "configured": 0    }  },  "key": {    "id": "key_7fK2mQ9xLpR3sT1v",    "name": "Сервер статистики",    "scopes": [      "channels",      "viewers"    ],    "expires_at": null,    "daily_spend_limit": null,    "spent_today": null  }}

Ответ 401 означает, что ключ передан неверно; причина — в поле error.code. Коды перечислены в разделе Ошибки.

Заведите каналСкопировать ссылку на раздел

Канал заводится с потолком — наибольшим числом зрителей, которое на нём можно запустить:

curl https://api.skystream.su/app/v1/channels \  -X POST \  -H "Authorization: Bearer $API_KEY" \  -H "Content-Type: application/json" \  -d '{    "platform": "twitch",    "name": "example_channel",    "viewers": 100  }'

Ответ 201 — заведённый канал. Его идентификатор id понадобится в следующих запросах:

{  "id": "ch_12",  "platform": "twitch",  "name": "example_channel",  "viewers": 100,  "temporary": false,  "expires_at": "2026-12-31T21:00:00.000Z",  "run": null}

Срок канала совпадает со сроком лимита. run равно null: канал ещё не запущен.

Запустите зрителейСкопировать ссылку на раздел

curl https://api.skystream.su/app/v1/channels/ch_12/start \  -X POST \  -H "Authorization: Bearer $API_KEY"

Ответ — канал с запуском в поле run:

{  "id": "ch_12",  "platform": "twitch",  "name": "example_channel",  "viewers": 100,  "temporary": false,  "expires_at": "2026-12-31T21:00:00.000Z",  "run": {    "id": "run_345",    "status": "waiting",    "viewers": 100,    "active_viewers": 0,    "started_at": "2026-09-29T12:00:00.000Z",    "ends_at": "2026-09-30T12:00:00.000Z"  }}

Сразу после запуска статус — waiting: запуск ждёт начала эфира. Когда эфир идёт, статус — running, и зрители набираются до заказанного числа run.viewers за время разгона из настроек канала. ends_at — момент, когда запуск остановится сам.

Остановить запуск:

curl https://api.skystream.su/app/v1/channels/ch_12/stop \  -X POST \  -H "Authorization: Bearer $API_KEY"