Skip to main content

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​

FieldTypeDescriptionDefault
typeconference, webinar, broadcast, chatDefault room type"conference"
audioSettingallow, approval, disallowMicrophone"allow"
videoSettingallow, approval, disallowCamera"allow"

Optional: More controls​

Fine-tune screen share, chat, resolution, co-hosts.

FieldTypeDescriptionDefault
screenshareSettingallow, approval, disallowScreen share"allow"
chatSettingallow, disallowChat"allow"
targetResolutionsd, hd, fhd, qhd, QnHDMax resolution"hd"
addCoHostbooleanAllow co-hostsfalse

Optional: AI notes​

Turn on AI notes and point at a translation config.

FieldTypeDescriptionDefault
enableAiNotesbooleanEnable AI notesfalse
translationConfigNickNametextTranslation 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.

FieldTypeDescriptionDefault
typeconference, webinar, broadcast, chatDefault room type"conference"
audioSettingallow, approval, disallowMicrophone"allow"
videoSettingallow, approval, disallowCamera"allow"
screenshareSettingallow, approval, disallowScreen share"allow"
chatSettingallow, disallowChat"allow"
targetResolutionsd, hd, fhd, qhd, QnHDMax resolution"hd"
addCoHostbooleanAllow co-hostsfalse

Optional: AI notes​

Adjust AI-notes wiring.

FieldTypeDescriptionDefault
enableAiNotesbooleanEnable AI notesfalse
translationConfigNickNametextTranslation 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.

FieldTypeDescriptionDefault
startIndexnumberStart index0
pageSizenumber (1–100)Page size20
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.