Getting Started

Set the streamConfigurationTemplateId=$CONFIG_ID, persist=true, and any other patches as query parameters and upload the binary data as the body of the request.

The configuration-specific patches (parameters) can be found under the Parameters section of the configuration page.

The body will be sent as binary data on the request body. The actual body can be one of the options mentioned under the Input data section of the configuration page.

curl --request POST \
  --url "https://http-gateway.vatis.tech/http-gateway/api/v1/upload?id=$STREAM_ID&streamConfigurationTemplateId=$CONFIG_ID&persist=true&language=en" \
  --header "Authorization: Basic $API_KEY" \
  --header 'Content-Type: application/octet-stream' \
  --data-binary @"$FILE_PATH" | jq

We can use dynamic webhooks to specify callback URLs at the request level that will be triggered when the state changes for the stream resource we’re creating. Generally, we’d want to know when the stream enters its COMPLETED or FAILED state. To declare a webhook for this two events we should set the following query parameters:

• webhook.stream.completed=http://my_domain/webhook-callback
• webhook.stream.failed=http://my_domain/webhook-callback

We should also set the common streamConfigurationTemplateId=$CONFIG_ID, persist=true, and any other patches as query parameters and upload the binary data as the body of the request.

curl --request POST \
  --url "https://http-gateway.vatis.tech/http-gateway/api/v1/upload?id=$STREAM_ID&streamConfigurationTemplateId=$CONFIG_ID&persist=true&language=en&webhook.stream.completed=http://my_domain/webhook-callback&webhook.stream.failed=http://my_domain/webhook-callback" \
  --header "Authorization: Basic $API_KEY" \
  --header 'Content-Type: application/octet-stream' \
  --data-binary @"$FILE_PATH" | jq

In some scenarios, the patches (parameters) values are too long to be included in the URL. In this case, we can use the multipart/form-data content type to send the patches as form data.

The request body will contain exactly two parts in this specific order:

1. The patches as JSON encoded HTTPStreamConfigurationDto
2. The binary data to be uploaded on the stream

Here’s an example of a stream configuration

{
  "patches": {
    "languages": "ro" ①
  },
  "webhook": {
    "http://my_domain/path": [ ②
      "stream.completed", "stream.failed" ③
    ]
  }
}

① The configuration-specific patches (parameters) can be found under the Parameters section of the configuration page

② The webhook URL

③ The events that will trigger the webhook. The complete list can be found here

The complete request will look like this:

curl --request POST \
  --url "https://http-gateway.vatis.tech/http-gateway/api/v1/upload?id=$STREAM_ID&streamConfigurationTemplateId=$CONFIG_ID&persist=true" \
  --header "Authorization: Basic $API_KEY" \
  --header 'Content-Type: multipart/form-data' \
  --form 'config={ "patches": {"language": "en"} };type=application/json' \
  --form "file=@$FILE_PATH;type=application/octet-stream" | jq

Considerations:

• The first part has a limit of 1 MB
• If possible, include the part content type (application/json, and application/octet-stream respectively)
• The parts name is not relevant

Run the following command until the result is COMPLETED:

curl --request GET \
  --url "https://stream-service.vatis.tech/stream-service/api/v1/streams/$STREAM_ID" \
  --header "Authorization: Basic $API_KEY" | jq '.state'

The configured webhook will be triggered with a POST request having the Webhook event payload containing the Stream state changed event.

From the received payload we should extract the streamId and the state as shown below:

{
    //...
    "payload": {
        "streamId": "stream_id",
        "state": "COMPLETED"
        //...
    }
}

If the stream state is FAILED, we should inspect the stream errors and retry the upload.

Refer to the Webhook integration for the complete webhooks documentation.