---
title: "Render a web link now"
method: POST
path: "/v1/media/{id}/render"
tags: ["media"]
---

# Render a web link now

`POST /v1/media/{id}/render`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/media/{id}/render`
- Auth: HTTP bearer

Capture and store a screenshot of a web or link asset. If screenshot rendering is not available for this workspace, the response reports that it is not configured rather than failing.

**Notes.**
- Usually queued (`queued: true`); the frame is then at GET /v1/media/{id}/render-frame.
- A second request while a render of the same link with the same settings is still queued or running returns `queued: true` and adds nothing. After an edit, the request queues a render of the new settings.

## Path parameters

- `id` string, required

## Response `200`

Success.

- object
  - `data` union, required
    - object
      - `ok` true, required
      - `queued` true, required
    - object
      - `ok` true, required
      - `key` string, required

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `404`: No media with this id.
- `429`: More than 60 renders a minute, or the workspace already has 4 web renders queued (`renders_busy`, retry after the Retry-After).
- `502`: The render failed.
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/7c2741bcdb16?raw)