# MediaSFU Developer Console Guide

Canonical interactive path: https://mediasfu.com/documentation

This plain-text guide is provided for agents, search tools, and users who need a readable map of the developer console guide without relying on client-side tab navigation.

## Audience

Use `/documentation` when the reader needs dashboard and API-facing configuration details. This surface can include endpoint behavior, request boundaries, schema-oriented settings, and developer handoff details. Use `/user-guide` for non-technical dashboard walkthroughs.

## Route Map

- `/documentation#basic-concepts` - MediaSFU concepts, SDK-first guidance, room lifecycle, permissions, recording, billing, and scalability.
- `/documentation#rooms` - room create, join, get/list, close, media server connection, and room sandbox guidance.
- `/documentation#domains` - domain create, update, delete, and list operations for approved access.
- `/documentation#events-settings` - event settings API and reusable room defaults. The internal tab key is `meetingRoomParams`.
- `/documentation#recording-settings` - recording settings, watermark behavior, recording quality, request parameters, responses, and sandbox guidance.
- `/documentation#sub-users` - sub-user creation, updates, deletion, listing, roles, and shared account control.
- `/documentation#recordings` - recording retrieval, recording data, and recording management workflows.
- `/documentation#ai-notes` - optional AI Notes support, room flags, translation output mode, notes-only behavior, and public sharing boundaries.
- `/documentation#ai-credentials` - AI credentials API and provider credential configuration.
- `/documentation#sip-configs` - SIP configuration API, provider details, routing, optional settings, query, update, and removal behavior.
- `/documentation#widgets` - widget configuration, allowed domains, authentication flow, embed behavior, event callbacks, and widget types.
- `/documentation#translation` - translation configuration, provider routing, output modes, AI Notes integration, and translation sandbox guidance.
- `/documentation#disposable-keys` - disposable key creation and management for short-lived access.

## Integration Boundaries

MediaSFU documentation separates three surfaces:

- `/docs/` is the canonical developer docs portal for SDK implementation, API reference, and modern usage guides.
- `/documentation` is the platform feature configuration guide for developers and technical operators.
- `/user-guide` is the dashboard-first guide for non-technical users and operators.

The SDK-first model keeps HTTP usage focused on room setup and management, while live in-room behavior is primarily socket-driven or handled by SDK methods.

## Key Developer Topics

### Rooms

Rooms provide the virtual space where users collaborate and stream content. The developer guide covers creating rooms, joining rooms, closing rooms, listing rooms, and understanding media server connections.

### Event Settings

Event settings define reusable room behavior such as participant layout, media defaults, room policy, and sub-user-specific settings. Search and routing should use `/documentation#events-settings`, while the implementation tab key is `meetingRoomParams`.

### Recording Settings

Recording settings cover quality, watermark-related behavior, recording defaults, request parameters, API responses, and dashboard-only upload requirements for watermark images.

### AI Credentials

AI credentials connect MediaSFU to AI providers. The developer surface is useful when credentials need to be created, rotated, selected, or attached from external systems.

### SIP Configs

SIP configs describe phone provider connection details, inbound and outbound routing, optional provider settings, peer or trunk details, callback behavior, and automated calling workflows.

### Widgets

Widgets cover the flow from dashboard configuration to backend storage, domain allowlists, browser authentication, embed snippets, rendering, and event callbacks.

### Translation and AI Notes

Translation covers real-time multilingual output, provider credentials, output mode, and optional AI Notes. AI Notes can run with translated playback or notes-only text output depending on room and configuration flags.

### Disposable Keys

Disposable keys support temporary access flows. Use the developer guide when key creation or selection must be automated by another system.

## Related Pages

- Dashboard user guide: https://mediasfu.com/user-guide
- Developer docs portal: https://mediasfu.com/docs/
- API reference: https://mediasfu.com/docs/api-reference
- Storybook visual companion: https://mediasfu.com/storybook/
- Machine-readable route index: https://mediasfu.com/guide-index.json