Hosted Workflows: API Introduction

This section shall detail several different scenarios which pertain to Vantage Cloud Hosted Workflows, with a concentration on how to interaction with this service via the API.

All API examples shall assume familiarity with the API Key for a given account. This key must be provided via an API Authorization (x-api-key) header within any REST messages being sent to the Vantage Cloud Hosted Workflow API.



All Vantage Cloud API capabilities require the specification of an API Key. This key is available in the IAM section of a given account. This key is passed within the header of any HTTP requests made to the Vantage Cloud APIs.

The API Key can be located within your Telestream Cloud account within the IAM action:

All examples which follow shall be made using the Postman application.

The authentication is specified as follows within Postman: