AirframeDocs

Create an instance

POST/v1/outputs/{id}/instances

Send an API key as a bearer token.

Prepares an instance of a component on an output, so it's ready to take with in. It shows in the control room straight away.

Path parameters

idstringRequired
The output's id.

Body

componentIdstringRequired
A component in the version the output plays.
namestringRequired
What operators see, up to 120 characters.
dataobject
Values by field key. Defaults to none, so the component's defaults show.

Response

The new instance, with the id to send as instance on in.