API Documentation
Retrieve a videoBeta
The videos endpoint returns the status and the URL of a video by its id, or streams its progress again.
GET https://api.bannerify.co/v1/videos/{id}
Beta. Read a video of `POST /v1/templates/renderVideo` by its id: its status, and its URL once it is done. With `stream=true` the answer is the stream of its events, from the latest one, as `renderVideo` sends them. Use it to wait for a video again after the connection dropped.
Query parameters
| Name | Type | Description |
|---|---|---|
id (required) | string | The id of the video, from `renderVideo`. |
apiKey (required) | string | Your API key. Create one on the API Keys page of the dashboard, and keep it on the server. |
stream | string | `true` streams the events of the video as server-sent events. |
Responses
200: The video, or its events.400: The request cannot be processed. BAD_REQUEST means a field is invalid, the API key is unknown, or a signed URL has a wrong signature. FETCH_IMAGE_ERROR means Bannerify could not download an image from a src URL. A rate limit on the PDF and stored endpoints also uses status 400 with the code TOO_MANY_REQUESTS. Read error.code to tell them apart.404: The template does not exist.500: The server could not finish the request. INTERNAL_SERVER_ERROR means an unexpected failure, such as a render error or a failed upload to your S3 bucket. USAGE_EXCEEDED means your workspace reached its daily or monthly generation limit, and RATE_LIMITED means the API key sent too many requests. Read error.code to tell them apart.
GET https://api.bannerify.co/v1/videos/{id}
Beta. Read a video of `POST /v1/templates/renderVideo` by its id: its status, and its URL once it is done. With `stream=true` the answer is the stream of its events, from the latest one, as `renderVideo` sends them. Use it to wait for a video again after the connection dropped.
Query parameters
| Name | Type | Description |
|---|---|---|
id (required) | string | The id of the video, from `renderVideo`. |
apiKey (required) | string | Your API key. Create one on the API Keys page of the dashboard, and keep it on the server. |
stream | string | `true` streams the events of the video as server-sent events. |
Responses
200: The video, or its events.400: The request cannot be processed. BAD_REQUEST means a field is invalid, the API key is unknown, or a signed URL has a wrong signature. FETCH_IMAGE_ERROR means Bannerify could not download an image from a src URL. A rate limit on the PDF and stored endpoints also uses status 400 with the code TOO_MANY_REQUESTS. Read error.code to tell them apart.404: The template does not exist.500: The server could not finish the request. INTERNAL_SERVER_ERROR means an unexpected failure, such as a render error or a failed upload to your S3 bucket. USAGE_EXCEEDED means your workspace reached its daily or monthly generation limit, and RATE_LIMITED means the API key sent too many requests. Read error.code to tell them apart.