Introduction

Welcome to the RapidStream API

Authentication

To authorize, use this code:

# With shell, you can just pass the correct header with each request
curl "https://api.rapidstream.video" \
  -H 'Authorization: Bearer ACCESSTOKEN' \

Make sure to replace ACCESSTOKEN with your API key.

In order to use the RapidStream API, you must authenticate yourself with an API key.

You can create a new API key at our customer panel. Make sure to save the key somewhere safe, as you won't be able to see it again.

Never share or commit your API key to a public repository. If you think your API key has been compromised, you can regenerate it at any time.

Authorization: Bearer ACCESSTOKEN

Ingest

Ingest EPG Catalog

curl -X "POST" "https://api.rapidstream.video/epg-ingest/catalog" \
     -H 'idempotency-key: YOUR-CUSTOM-UUID' \
     -H 'Content-Type: application/json' \
     -H 'Authorization: Bearer ACCESSTOKEN' \

The request body:

[
  {
    "id": "string",
    "title": "string",
    "episode": "string | undefined",
    "season": "string | undefined",
    "series": "string | undefined",
    "productionYear": "string | undefined",
    "duration": "string | undefined",
    "parentalRatings": "string | undefined",
    "ratings": "string | undefined",
    "language": "string | undefined",
    "keywords": "string | undefined",
    "genres": "string | undefined",
    "iabCategories": "string | undefined",
    "channelName": "string | undefined",
    "description": "string | undefined"
  }
]

This endpoint ingests a catalog of content.

HTTP Request

POST https://api.rapidstream.video/epg-ingest/catalog

Returns

204 - No Content

Query Headers

JSON Body

VAST

In general there are two ways to request a VAST document. You call the synchronous or asynchronous endpoints.

• The synchronous endpoint will return a VAST document as response.
• The asynchronous endpoints will run the job in the background and call the webhook url you provide.

Input parameters

Mandatory URL parameters

However you call the API, you need to provide the following information:

Well-known URL parameters

Next to this you may provide the following information:

All additional key-value pairs are valid and can be put into the url, once. Multiple values for the same key are not supported. Only the latest value is used.

Request VAST synchronously

Get a VAST document synchronously

curl -X "GET" "https://api.rapidstream.video/vast/sync" \
     -H 'idempotency-key: YOUR-CUSTOM-UUID' \
     -H 'Authorization: Bearer ACCESSTOKEN' \
     -H 'User-Agent: VIEWER_USER_AGENT' \
     -H 'X-Forwarded-For: VIEWER_IP_ADDRESS'

The response will look like this:

<VAST version="4.0">
    <Ad id="-m7LC9Ze" sequence="1">
        <InLine>
            ...
        </InLine>
    </Ad>
</VAST>

GET https://api.rapidstream.video/vast/sync

Returns

200 - OK

Query Headers

URL Parameters

Please see VAST / Input parameters for more information.

Request VAST asynchronously

Request a VAST document asynchronously and receive a VAST document by webhook.

curl -X "POST" "https://api.rapidstream.video/vast/async/webhook/in-body" \
     -H 'idempotency-key: YOUR-CUSTOM-UUID' \
     -H 'Authorization: Bearer ACCESSTOKEN' \
     -H 'User-Agent: VIEWER_USER_AGENT' \
     -H 'X-Forwarded-For: VIEWER_IP_ADDRESS'

The request body should look like this:

{
  "url": "WEBHOOK_URL",
  "secret": "WEBHOOK_SECRET"
}

The webhook call you will receive with the VAST document on success.

{
  "status": "success",
  "vastId": "0f6bbdbce0fedf518b8792dd50d50ee5",
  "vast": "<VAST version=\"4.0\">...</VAST>"
}

The webhook call you will receive with the VAST document on failure.

{
  "status": "failure",
  "vastId": "0f6bbdbce0fedf518b8792dd50d50ee5",
  "message": "error description"
}

GET https://api.rapidstream.video/vast/async/webhook/in-body

Returns

204 - No content

Query Headers

JSON Body

URL Parameters

Please see VAST / Input parameters for more information.

Errors

The RapidStream API uses the following error codes:

The error response body will look like this:

{
  "status": "number",  // HTTP status code
  "title": "string",
  "type": "string",
  "detail": "string",
  "key": "values"      // Additional information about the error, 
                       // e.g. list of invalid fields
}