List instances
GET/v1/outputs/{id}/instances
Send an API key as a bearer token.
The instances prepared for an output. An instance is a component with saved data, such as a lower third for each guest, ready to put on air with in.
Path parameters
idstringRequired
The output's id.
Response
instancesInstance[]
Each has an
id, the componentId it belongs to, a name and its data by field key.liveInstancesobject
Which instance each component on air is showing, by component id.
Every component has a default instance, with the id default: followed by the component's id and isDefault: true. You can change its data and take it, but not remove it.
Instances belong to the output, not the version: moving to another version of the same composition keeps them.