docs: Move obs-websocket vendor request reference to API.md

- Relocate the vendor request section from README to API.md / API_ja.md
- README now points to the API reference for details
- Trim internal implementation notes; keep only user-facing limitations

Author: hanatyan128

API.md

@@ -277,3 +277,99 @@ Reads the value of a text input and applies it to the stream recording filename
 #### replay-buffer-filename-from-text
 
 Reads the value of a text input and applies it to the replay buffer save filename format. The override takes effect on the next save; the replay buffer itself is not restarted.
+
+## obs-websocket Vendor Requests
+
+The same filename-override operations (and the filter listing helper) are also exposed as **obs-websocket vendor requests**, so external tools, bots, or Stream Deck integrations can drive the plugin over obs-websocket without running an in-process OBS script.
+
+- **Vendor name:** `osi_branch_output`
+- **Transport:** obs-websocket 5.x `CallVendorRequest`
+- **Requirement:** obs-websocket must be installed. If not, these requests are unavailable.
+
+### Security
+
+Vendor requests require a client authenticated with obs-websocket. The obs-websocket password grants full access to every request below — treat it as a credential equivalent to OBS user authority. When exposing obs-websocket beyond `localhost`, use a strong password and a trusted network.
+
+### Limitations
+
+- `filter_uuid` must be a 36-character hyphenated UUID string. Other shapes are rejected with `"filter_uuid must be a UUID string"`.
+- `format` cannot exceed 1024 bytes. Longer strings are rejected with `"format too long"`.
+- `filter_uuid` must resolve to a Branch Output filter source. Any other source (including non-existent UUIDs) is rejected with `"Filter not found"`.
+- Do not send bursts of requests while a recording transition (file split, restart) is in progress — a request may block until the transition completes.
+
+### `get_filter_list`
+
+Enumerates every Branch Output filter currently loaded in OBS.
+
+| Item | Description |
+|------|-------------|
+| Request type | `get_filter_list` |
+| Request data | *(none)* |
+| Response | `{ "success": bool, "error"?: string, "filters": array }` |
+
+Each element of the `filters` array:
+
+| Field | Description |
+|-------|-------------|
+| `source_name` | Name of the parent source/scene to which the Branch Output filter is applied |
+| `source_uuid` | UUID of the parent source/scene |
+| `filter_name` | Name of the Branch Output filter |
+| `filter_uuid` | UUID of the Branch Output filter (used with the override requests below) |
+
+Filters applied to **private sources** are excluded, matching the Status Dock's visibility rules.
+
+### `override_recording_filename_format`
+
+Overrides the stream-recording filename format for a specific Branch Output filter.
+
+| Item | Description |
+|------|-------------|
+| Request type | `override_recording_filename_format` |
+| Request data | `{ "filter_uuid": string, "format": string }` |
+| Response | `{ "success": bool, "error"?: string }` |
+| Clearing the override | Pass an empty string for `format`. |
+
+Behavior during recording is identical to the proc handler — see [Overriding the Stream Recording Filename Format](#overriding-the-stream-recording-filename-format) above.
+
+### `override_replay_buffer_filename_format`
+
+Overrides the replay buffer save filename format for a specific Branch Output filter.
+
+| Item | Description |
+|------|-------------|
+| Request type | `override_replay_buffer_filename_format` |
+| Request data | `{ "filter_uuid": string, "format": string }` |
+| Response | `{ "success": bool, "error"?: string }` |
+| Clearing the override | Pass an empty string for `format`. |
+
+The override takes effect on the next replay buffer save.
+
+### Example
+
+Request:
+
+```json
+{
+  "requestType": "CallVendorRequest",
+  "requestData": {
+    "vendorName": "osi_branch_output",
+    "requestType": "override_recording_filename_format",
+    "requestData": {
+      "filter_uuid": "87654321-4321-4321-4321-cba987654321",
+      "format": "%CCYY-%MM-%DD %hh-%mm-%ss MyScene"
+    }
+  }
+}
+```
+
+Successful response:
+
+```json
+{ "success": true }
+```
+
+Failure response (invalid UUID):
+
+```json
+{ "success": false, "error": "filter_uuid must be a UUID string" }
+```

API_ja.md

@@ -277,3 +277,99 @@ Windows の場合、スクリプトは OBS インストールパスの `data\obs
 #### replay-buffer-filename-from-text
 
 テキストインプットの値を読み取ってリプレイバッファー保存時のファイル名フォーマットに反映します。オーバーライドは次回の保存時に反映され、リプレイバッファー自体は再起動しません。
+
+## obs-websocket vendor request
+
+上記のファイル名オーバーライドおよびフィルター一覧取得機能は、**obs-websocket の vendor request** としても公開されています。OBS のスクリプト機構を使わず、外部ツールやボット、Stream Deck 連携から obs-websocket 経由で直接操作できます。
+
+- **ベンダー名 (vendor name):** `osi_branch_output`
+- **トランスポート:** obs-websocket 5.x の `CallVendorRequest`
+- **必要条件:** obs-websocket がインストールされていること。未インストールの場合は以下のリクエストは利用できません。
+
+### セキュリティ
+
+vendor request は obs-websocket に認証済みのクライアントからのみ受け付けられます。obs-websocket のパスワードは以下のすべてのリクエストに対するフルアクセス権と等価であり、OBS ユーザー相当の資格情報として扱ってください。obs-websocket を `localhost` 以外に公開する場合は、強固なパスワードと信頼できるネットワークを使用してください。
+
+### 制限事項
+
+- `filter_uuid` は 36 文字のハイフン付き UUID 文字列である必要があります。それ以外の形式は `"filter_uuid must be a UUID string"` で拒否されます。
+- `format` は 1024 バイトを超えられません。超過した場合は `"format too long"` で拒否されます。
+- `filter_uuid` は Branch Output フィルターソースに解決される必要があります。他種別のソースや存在しない UUID は `"Filter not found"` で拒否されます。
+- 録画遷移中（ファイル分割、リスタート）にリクエストを連続送信すると、遷移完了までリクエストがブロックされることがあります。
+
+### `get_filter_list`
+
+現在 OBS にロードされている Branch Output フィルター一覧を列挙します。
+
+| 項目 | 内容 |
+|------|------|
+| リクエストタイプ | `get_filter_list` |
+| リクエストデータ | *(なし)* |
+| レスポンス | `{ "success": bool, "error"?: string, "filters": array }` |
+
+`filters` 配列の各要素:
+
+| フィールド | 内容 |
+|-----------|------|
+| `source_name` | Branch Output フィルターが適用されている親ソース／シーン名 |
+| `source_uuid` | 親ソース／シーンの UUID |
+| `filter_name` | Branch Output フィルターの名前 |
+| `filter_uuid` | Branch Output フィルターの UUID（下記のオーバーライドリクエストで使用） |
+
+**プライベートソース**に適用されたフィルターは、ステータスドックの表示ルールに合わせて結果から除外されます。
+
+### `override_recording_filename_format`
+
+指定した Branch Output フィルターのストリーム録画ファイル名フォーマットをオーバーライドします。
+
+| 項目 | 内容 |
+|------|------|
+| リクエストタイプ | `override_recording_filename_format` |
+| リクエストデータ | `{ "filter_uuid": string, "format": string }` |
+| レスポンス | `{ "success": bool, "error"?: string }` |
+| オーバーライド解除 | `format` に空文字列を指定 |
+
+録画中の挙動はプロシージャハンドラと同一です。上記の[録画中の挙動](#ストリーム録画ファイル名フォーマットのオーバーライド)を参照してください。
+
+### `override_replay_buffer_filename_format`
+
+指定した Branch Output フィルターのリプレイバッファ保存ファイル名フォーマットをオーバーライドします。
+
+| 項目 | 内容 |
+|------|------|
+| リクエストタイプ | `override_replay_buffer_filename_format` |
+| リクエストデータ | `{ "filter_uuid": string, "format": string }` |
+| レスポンス | `{ "success": bool, "error"?: string }` |
+| オーバーライド解除 | `format` に空文字列を指定 |
+
+オーバーライドは次回のリプレイバッファ保存時に反映されます。
+
+### 呼び出し例
+
+リクエスト:
+
+```json
+{
+  "requestType": "CallVendorRequest",
+  "requestData": {
+    "vendorName": "osi_branch_output",
+    "requestType": "override_recording_filename_format",
+    "requestData": {
+      "filter_uuid": "87654321-4321-4321-4321-cba987654321",
+      "format": "%CCYY-%MM-%DD %hh-%mm-%ss MyScene"
+    }
+  }
+}
+```
+
+成功時のレスポンス:
+
+```json
+{ "success": true }
+```
+
+失敗時のレスポンス（UUID 形式不正の場合）:
+
+```json
+{ "success": false, "error": "filter_uuid must be a UUID string" }
+```

README.md

@@ -119,7 +119,7 @@ Branch Output exposes public procedures that let external scripts override the s
 
 Sample scripts (`recording-filename-from-text` and `replay-buffer-filename-from-text`) are bundled with the plugin in both **Python** (`.py`) and **Lua** (`.lua`) variants, and can be loaded from OBS Tools → Scripts.
 
-See the [API reference](./API.md) for procedure signatures, sample code, and usage instructions for the bundled scripts.
+See the [API reference](./API.md) for procedure signatures, sample code, and usage instructions for the bundled scripts. The same filename-override operations are also exposed as **obs-websocket vendor requests** for integration with external tools, bots, and Stream Deck plugins — see the API reference for details.
 
 # Development
 

README_ja.md

@@ -121,7 +121,7 @@ Branch Output は、外部スクリプトから実行時にストリーム録画
 
 サンプルスクリプト（`recording-filename-from-text` および `replay-buffer-filename-from-text`）は、**Python**（`.py`）版と **Lua**（`.lua`）版の両方がプラグインに同梱されており、OBS の Tools → Scripts からロードして使用できます。
 
-プロシージャのシグネチャ、サンプルコード、同梱スクリプトの使用方法については [API リファレンス](./API_ja.md) を参照してください。
+プロシージャのシグネチャ、サンプルコード、同梱スクリプトの使用方法については [API リファレンス](./API_ja.md) を参照してください。同じファイル名オーバーライド機能は **obs-websocket の vendor request** としても公開されており、外部ツールやボット、Stream Deck 連携から利用できます。詳細は API リファレンスを参照してください。
 
 # Development