OBS WebSocket API
The official remote-control API, usable by a custom script or agent bridge.
Open maintainer documentationWHAT YOU CAN DOInspect scenes · Switch program scene · Start and stop recording
HOW IT WORKSLive app
PLATFORMSWindows · macOS · Linux
DOCUMENTED AGENTSSee compatibility details
Documented capabilities
- Inspect scenesDocumentation
- Switch program sceneDocumentation
- Start and stop recordingDocumentation
Agent compatibility
| Agent | Compatibility | Basis |
|---|---|---|
| Claude Code | Not documented | A custom client script or bridge is required; agent-specific setup is not listed. |
| Codex | Not documented | A custom client script or bridge is required; agent-specific setup is not listed. |
| Cursor | Not documented | A custom client script or bridge is required; agent-specific setup is not listed. |
Setup route
Follow the linked maintainer installation guide. Review dependencies and permissions before running third-party code.
OBS with WebSocket enabled, authenticated connection, and a separate client script or bridge.
Limitations
This is a WebSocket API. Connecting an AI agent requires a client script or an additional MCP bridge.