Event settings API
Account-level defaults applied to new rooms — what participants may do, plus AI-notes wiring.
Endpoint: https://mediasfu.com/v1/eventssettings
Authenticate with Authorization: Bearer <api-username>:<api-key> from your server. Try every action and copy the request in the API Sandbox.
Set defaults
POST https://mediasfu.com/v1/eventssettings with action: "create"
Define the default settings applied to new rooms.
Required fields
| Field | Type | Description | Default |
|---|---|---|---|
type | conference, webinar, broadcast, chat | Default room type | "conference" |
audioSetting | allow, approval, disallow | Microphone | "allow" |
videoSetting | allow, approval, disallow | Camera | "allow" |
Optional: More controls
Fine-tune screen share, chat, resolution, co-hosts.
| Field | Type | Description | Default |
|---|---|---|---|
screenshareSetting | allow, approval, disallow | Screen share | "allow" |
chatSetting | allow, disallow | Chat | "allow" |
targetResolution | sd, hd, fhd, qhd, QnHD | Max resolution | "hd" |
addCoHost | boolean | Allow co-hosts | false |
Optional: AI notes
Turn on AI notes and point at a translation config.
| Field | Type | Description | Default |
|---|---|---|---|
enableAiNotes | boolean | Enable AI notes | false |
translationConfigNickName | text | Translation config. Required when AI notes are on — a translation config nickname. |
curl -X POST https://mediasfu.com/v1/eventssettings \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $MEDIASFU_API_USERNAME:$MEDIASFU_API_KEY" \
-d '{"action":"create","type":"conference","audioSetting":"allow","videoSetting":"allow"}'
Update defaults
POST https://mediasfu.com/v1/eventssettings with action: "update"
Change only the settings you specify.
No fields are required.
Optional: Controls
Any settings you want to change.
| Field | Type | Description | Default |
|---|---|---|---|
type | conference, webinar, broadcast, chat | Default room type | "conference" |
audioSetting | allow, approval, disallow | Microphone | "allow" |
videoSetting | allow, approval, disallow | Camera | "allow" |
screenshareSetting | allow, approval, disallow | Screen share | "allow" |
chatSetting | allow, disallow | Chat | "allow" |
targetResolution | sd, hd, fhd, qhd, QnHD | Max resolution | "hd" |
addCoHost | boolean | Allow co-hosts | false |
Optional: AI notes
Adjust AI-notes wiring.
| Field | Type | Description | Default |
|---|---|---|---|
enableAiNotes | boolean | Enable AI notes | false |
translationConfigNickName | text | Translation config. Required when AI notes are on — a translation config nickname. |
curl -X POST https://mediasfu.com/v1/eventssettings \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $MEDIASFU_API_USERNAME:$MEDIASFU_API_KEY" \
-d '{"action":"update"}'
List / get
GET https://mediasfu.com/v1/eventssettings with action: "get"
Retrieve records. Everything is optional — send as-is to list all.
No fields are required.
Optional: Filters
All optional — narrow or page the results.
| Field | Type | Description | Default |
|---|---|---|---|
startIndex | number | Start index | 0 |
pageSize | number (1–100) | Page size | 20 |
curl "https://mediasfu.com/v1/eventssettings?action=get" \
-H "Authorization: Bearer $MEDIASFU_API_USERNAME:$MEDIASFU_API_KEY"
See errors and response format for failure handling.