Studio Guest Invite Link

Get the link guests use to join a Studio event

Info

Required scope: stream.read

Warning

This method requires authentication

Return the guest invite link of a Studio event. Anyone who opens the link joins the event's Studio room as a guest, so share it only with the people you want on stage. The link is for guests only. It doesn't grant host access, and it isn't a webinar registration link.

curl -H "Authorization: Bearer [access token]" \
     https://api.restream.io/v2/user/events/{eventId}/studio/guest-invite

Path Parameters:

ParameterTypeDescription
eventIdstring (UUID)The UUID of the event (required)

Response

Success
Error (event not found)
Error (not a Studio event)
Error (event finished)
{
  "url": "https://studio.restream.io/exxx-xxxx-xxx"
}
StatusnameWhen
401invalid_tokenThe access token is missing or invalid
403insufficient_scopeThe access token lacks the stream.read scope
404event_not_foundThe event doesn't exist or doesn't belong to the authenticated user
409event_not_studioThe event streams from an encoder, a file, or a recording, not Studio
409event_finishedThe event has ended and guests can no longer join it
  • Each Studio event has its own link. Requesting it doesn't change it, so you can fetch it as often as you need.
  • The link doesn't expire on its own. It stays valid until the host generates a new one or the event ends.
  • If the host generates a new link in Studio, the old one stops working. Fetch the link again to get the new one.
  • Once the event finishes, the link stops working and this endpoint returns 409 event_finished. Discard any stored link for that event.
  • A duplicated event gets its own link.