List all scene collections and the currently active one.

Switch to a scene collection by name. Blocks until the switch completes.

Create a new scene collection and switch to it.

List all profiles and the currently active one.

Switch to a profile by name.

Create a new profile and switch to it.

Remove a profile. If it's the active one, OBS switches away first.

Read a raw parameter from the current profile's .ini configuration.

Args: category: Config category, e.g. "Output". name: Parameter name within that category.

Write a raw parameter into the current profile's .ini configuration. Advanced/low-level — prefer a dedicated request when one exists.

Args: category: Config category, e.g. "Output". name: Parameter name within that category. value: New value, or None to delete the parameter.

Current canvas/output resolution and FPS (as a fraction — divide fpsNumerator by fpsDenominator for the true FPS).

Change canvas/output resolution and/or FPS. Width/height fields must be set in pairs (can't change baseWidth without baseHeight, etc). Range 1-4096 for all resolution fields.

Current stream destination service type and settings (server/key etc).

Set the stream destination. For a plain custom RTMP target, use service_type="rtmp_custom" and settings={"server": "...", "key": "..."}.

Args: service_type: e.g. "rtmp_custom" or "rtmp_common". settings: Service-specific settings object.

Current output directory for recordings.

Set the output directory recordings are written to.

Args: path: Absolute directory path.

List every filter kind this OBS install supports (noise_suppress_filter, noise_gate_filter, compressor_filter, color_filter, chroma_key_filter, etc).

List all filters on a source (input or scene), in chain order.

Args: source_name: Name of the source.

Default settings object for a filter kind.

Add a new filter to a source.

Args: source_name: Name of the source to add the filter to. filter_name: Name for the new filter. filter_kind: Filter kind (see get_source_filter_kind_list). filter_settings: Optional initial settings.

Remove a filter from a source.

Rename a filter.

Get a filter's enabled state, chain index, kind, and settings.

Reorder a filter within a source's filter chain.

Args: source_name: Name of the source. filter_name: Name of the filter to move. filter_index: New position, >= 0 (0 = first in chain).

Configure a filter's parameters.

Args: source_name: Name of the source. filter_name: Name of the filter. filter_settings: Settings object. overlay: True = merge on top of current settings, False = reset to defaults first.

Enable or disable a filter without removing it.

OBS/obs-websocket version info, platform, and the full list of requests available on this connection (availableRequests).

Live perf stats: CPU/memory usage, active FPS, render/output skipped frames, disk space. Use to check for dropped-frame problems mid-stream.

Broadcast a CustomEvent to all subscribed obs-websocket clients.

Args: event_data: Arbitrary JSON payload delivered to receivers.

Call a request registered by a third-party OBS plugin/script vendor.

Args: vendor_name: Unique vendor name registered by the plugin. request_type: The vendor's request type to call. request_data: Optional payload for the vendor request.

List all hotkey names in OBS. Best-effort — hotkey requests are less reliable than dedicated requests when one exists for the same action.

Trigger a hotkey by its name (see get_hotkey_list).

Args: hotkey_name: Name of the hotkey to trigger. context_name: Optional hotkey context name.

Trigger a hotkey by simulating a key press + modifiers.

Args: key_id: OBS key ID (see obs-studio's obs-hotkeys.h for the list). shift/control/alt/command: Modifier keys to hold.

Get a value from an OBS persistent-data "slot".

Args: realm: "OBS_WEBSOCKET_DATA_REALM_GLOBAL" or "OBS_WEBSOCKET_DATA_REALM_PROFILE". slot_name: Name of the slot to read.

Set a value in an OBS persistent-data "slot" — useful for storing state the AI needs to remember across tool calls (e.g. giveaway winners).

Args: realm: "OBS_WEBSOCKET_DATA_REALM_GLOBAL" or "OBS_WEBSOCKET_DATA_REALM_PROFILE". slot_name: Name of the slot to write. slot_value: Any JSON-serializable value.

List all inputs (sources like mic, capture card, browser source, etc).

Args: input_kind: Optional — restrict to one kind (see get_input_kind_list).

List every input kind (source type) this OBS install can create.

Names of the built-in special audio inputs: Desktop Audio 1/2, Mic/Aux 1-4. Use these names to control the default audio channels.

Create a new input and add it as a scene item to a scene.

Args: input_name: Name for the new input. input_kind: Kind of input to create (see get_input_kind_list). scene_name: Scene to add it to. input_settings: Optional initial settings object. scene_item_enabled: Whether the new scene item starts visible.

Delete an input. Removes all its scene items too.

Args: input_name: Name of the input to remove.

Rename an input.

Args: input_name: Current name. new_input_name: New name.

Default settings object for an input kind — overlay get_input_settings on top of this to reconstruct the full effective settings.

Current (non-default) settings of an input, plus its kind.

Args: input_name: Name of the input.

Set an input's settings.

Args: input_name: Name of the input. input_settings: Settings object to apply. overlay: True = merge on top of current settings, False = reset to defaults first then apply.

Get an input's mute state.

Mute or unmute an input.

Toggle an input's mute state.

Get an input's volume as both a linear multiplier and dB.

Set an input's volume — pass exactly one of volume_db or volume_mul.

Args: input_name: Name of the input. volume_db: Volume in dB, range -100..26. volume_mul: Volume as a linear multiplier, range 0..20.

Get an input's stereo balance (0.0 full left .. 1.0 full right, 0.5 center).

Set an input's stereo balance.

Args: input_name: Name of the input. balance: 0.0 (full left) to 1.0 (full right), 0.5 = center.

Get an input's audio sync offset in milliseconds (can be negative).

Set an input's audio sync offset — use to fix audio/video drift.

Args: input_name: Name of the input. offset_ms: Offset in milliseconds, range -950..20000.

Get an input's monitoring mode (none / monitor-only / monitor-and-output).

Set an input's monitoring mode.

Args: input_name: Name of the input. monitor_type: One of OBS_MONITORING_TYPE_NONE, OBS_MONITORING_TYPE_MONITOR_ONLY, OBS_MONITORING_TYPE_MONITOR_AND_OUTPUT.

Get which of the 6 audio mixer tracks this input is routed to.

Set which audio mixer tracks an input is routed to.

Args: input_name: Name of the input. audio_tracks: Object like {"1": true, "2": false, ...} for tracks 1-6.

Get an input's deinterlace mode. Async inputs only (capture cards, etc).

Set an input's deinterlace mode.

Args: input_name: Name of the input. mode: One of OBS_DEINTERLACE_MODE_DISABLE, _DISCARD, _RETRO, _BLEND, _BLEND_2X, _LINEAR, _LINEAR_2X, _YADIF, _YADIF_2X.

Get an input's deinterlace field order. Async inputs only.

Set an input's deinterlace field order.

Args: input_name: Name of the input. field_order: OBS_DEINTERLACE_FIELD_ORDER_TOP or _BOTTOM.

Get the items of a dynamic list property on an input — e.g. the available displays for a display-capture source.

Args: input_name: Name of the input. property_name: Name of the list property.

Press a button in an input's properties — e.g. "refreshnocache" to reload a browser source.

Args: input_name: Name of the input. property_name: Name of the button property to press.

Playback state (playing/paused/stopped/buffering/ended/error), duration, and cursor position of a media source.

Seek a media source to an absolute position. No bounds checking.

Args: input_name: Name of the media input. cursor_ms: Position in milliseconds.

Seek a media source relative to its current position. No bounds checking.

Args: input_name: Name of the media input. offset_ms: Milliseconds to offset by (negative = seek backward).

Trigger a transport action on a media source.

Args: input_name: Name of the media input. action: One of OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PLAY, _PAUSE, _STOP, _RESTART, _NEXT, _PREVIOUS.

Whether the virtual camera output is active.

Toggle the virtual camera on/off.

Start the virtual camera.

Stop the virtual camera.

Whether the replay buffer is active.

Toggle the replay buffer on/off.

Start the replay buffer.

Stop the replay buffer.

Save the last N seconds from the replay buffer to disk — the "instant replay" clip-save action.

File path of the last replay buffer save.

List every registered OBS output (stream, record, virtualcam, replay buffer, and any plugin-added outputs).

Detailed status of a named output: active/reconnecting, timecode, duration, congestion, bytes sent, frame counts.

Toggle a named output on/off.

Start a named output.

Stop a named output.

Get a named output's settings object.

Set a named output's settings object.

Set up a standard mic-cleanup filter chain in one call: Noise Gate -> Noise Suppression -> Compressor, in that order (order matters — gate first cuts room noise between words, suppression reduces steady background hiss while you're talking, compressor evens out what's left).

Skips any filter kind that already exists on the input by that name instead of duplicating it. Removing a stage later is a normal remove_source_filter call — this only handles the one-shot setup.

Args: input_name: Name of the mic/audio input to clean up. gate/suppression/compressor: Which stages to add (all on by default). gate_open_threshold_db: Gate opens above this level. Should sit slightly below your voice level. Default -26 dB. gate_close_threshold_db: Gate closes below this level. Should sit above the room's noise floor, 5-8 dB below open threshold. Default -32 dB. suppression_method: "rnnoise" (better quality, default) or "speex" (lighter weight, older). compressor_ratio: Compression ratio, 1.0-32.0. Default 3.0 (gentle). compressor_threshold_db: Level compression kicks in at, -60..0 dB. Default -18 dB.

Diagnose why a stream/recording might be dropping frames or stuttering — pulls GetStats + GetStreamStatus + GetRecordStatus in one call and interprets the ratios instead of leaving the AI to fetch three things and do the arithmetic itself.

The three numbers that actually matter, and what each one means:

• renderSkippedFrames/renderTotalFrames high: OBS's render thread can't keep up with your scene (too many sources/filters, canvas resolution too high, or GPU-bound). Fix: lower canvas resolution, cut filters, simplify the scene.

• outputSkippedFrames/outputTotalFrames high with LOW congestion: encoding can't keep up (CPU/GPU encoder overloaded). Fix: switch to a hardware encoder (NVENC/AMF/QSV), lower the encoder preset, or lower output resolution/fps.

• outputCongestion high: the network can't keep up with your bitrate. Fix: lower bitrate, check upload speed.

These thresholds are heuristics, not authoritative OBS cutoffs — a few skipped frames right after starting a stream is normal; this flags sustained skip ratios worth investigating, not noise.

List every scene item (placed source) in a scene.

Like get_scene_item_list, but for a group (OBS groups are broken under the hood — prefer nested scenes over groups where possible).

Find a scene item's numeric ID by the source name it references.

Args: scene_name: Scene or group to search. source_name: Name of the source to find. search_offset: Matches to skip. -1 = last (topmost) match.

Get the source name/UUID a scene item references.

Add an existing source to a scene as a new scene item.

Args: scene_name: Scene to add the item to. source_name: Existing source (input) to place. scene_item_enabled: Whether it starts visible.

Remove a scene item from a scene (does not delete the underlying source).

Duplicate a scene item, copying its transform/crop, optionally into a different scene.

Args: scene_name: Scene the item is currently in. scene_item_id: Numeric ID of the item to duplicate. destination_scene_name: Target scene; defaults to the source scene.

Get a scene item's position, scale, rotation, and crop.

Set a scene item's position/scale/rotation/crop.

Args: scene_name: Scene the item is in. scene_item_id: Numeric ID of the item. transform: Object with any of positionX/positionY, rotation, scaleX/scaleY, alignment, boundsType/boundsAlignment/ boundsWidth/boundsHeight, cropLeft/Right/Top/Bottom.

Get whether a scene item is currently visible (shown/hidden, not mute).

Show or hide a scene item.

Args: scene_name: Scene the item is in. scene_item_id: Numeric ID of the item. enabled: True = visible, False = hidden.

Get a scene item's lock state (locked items can't be moved/resized in the UI).

Lock or unlock a scene item.

Get a scene item's stacking position (0 = bottom of the source list).

Reorder a scene item's stacking position (z-order).

Args: scene_name: Scene the item is in. scene_item_id: Numeric ID of the item. index: New position, >= 0 (0 = bottom of the source list).