get_live
Retrieve a Patreon livestream's state and RTMP connection details; optionally include the stream key when needed for broadcasting.
Instructions
Get a livestream's state and RTMP connection details.
The stream key is redacted unless include_stream_key is true.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"live_id": "<live_id>"
},
"name": "get_live"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| live_id | Yes | Live ID. | |
| include_stream_key | No | Include the RTMP stream key. Off by default because it is a streaming credential. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| state | No | ||
| title | No | ||
| rtmp_url | No | ||
| stream_key | No | ||
| description | No | ||
| scheduled_for | No |