About
The Kaltura Virtual Events API lets you manage Kaltura Virtual Events programmatically. You can use it to integrate Events into external systems and workflows, such as creating or updating events from a CRM or internal tool.
The API includes endpoints for managing events, retrieving and deleting sessions, managing team members and event users, and managing session participants such as speakers and moderators.
For full technical details, download the Events API OpenAPI Specification (JSON).
What you can do with the Kaltura Virtual Events API
Manage events
You can manage events using the following endpoints:
- List events
- Create events
- Update events
- Delete events
When creating an event, you can use the createSingleSession field to create the event as a Single Session event, a single session that serves as the entire event, instead of the multi-session and channel structure defined by the event template. This requires the Single Session capability to be enabled for your account.
If createSingleSession is set to true, you can also use singleSessionType to specify the type of that session:
LiveWebcastLiveKMESimuLive
If you don't specify singleSessionType while createSingleSession is true, the selected template must define exactly one session. That session's type is used automatically. MeetingEntry and VirtualLearningRoom are not supported for Single Session events.
These endpoints let you control basic event details programmatically instead of managing them manually in Kaltura Virtual Events.
Manage event sessions
You can retrieve a list of sessions for a specific event and delete sessions using the API.
For each session, the API returns basic session details, allowing external systems to access session-level information related to an event.
Manage event team members
You can manage event team members using the API, including:
- List team members
- Create team members
- Update team members
- Delete team members
- Assign team members to events
- Disable and re-enable team members
Disabling a team member prevents them from accessing Kaltura Virtual Events management, but doesn't prevent them from attending events. If the team member is re-enabled, they regain access to the events they were previously involved in.
This allows you to control who can manage events and which roles they have through an external system.
For information about team members, see Add team members to your event.
Manage event users
You can manage event users using the API, including:
- Create and invite users
- Retrieve users
- Update users
- Remove users from an event
There's no single call to remove a user from everything at once. To fully remove someone, remove them from each event and, if they're a team member, delete the team member separately.
You can also assign event roles such as:
- Attendee
- Speaker
- Moderator
This allows external systems to manage event participants and their roles programmatically.
'Team member' roles (Admins, Organizers, and Content managers) are managed separately - see the Manage event team members section above.
For information about event users, see Event user roles.
Manage session participants
You can manage session participants using the API, including:
- Assign speakers to sessions
- Remove speakers from sessions
- Update speaker settings for a session
- Assign moderators to sessions
- Remove moderators from sessions
This allows external systems to manage session speakers and moderators programmatically.
