---
title: "Create an instant URL"
method: POST
path: "/instant_urls"
---

# Create an instant URL

`POST /instant_urls`

## Request body

- object
  - `name` string, required
  - `template` string, required — Image template UID this Instant URL is bound to
  - `mode` 'encoded' | 'named_params'
  - `security` 'signed' | 'open'
  - `status` 'active' | 'disabled'
  - `scale` 1 | 2 | 3 | 4
  - `rate_limit` boolean
  - `template_version` integer, nullable
  - `max_renders` integer, nullable
  - `expires_at` string, date-time, nullable

## Response `201`

Instant URL created. The signing_key field is only returned here — store it now.

- object
  - `uid` string
  - `name` string
  - `template` string — Source image template UID
  - `template_version` integer, nullable — Pinned template version, or null for latest
  - `mode` 'encoded' | 'named_params'
  - `security` 'signed' | 'open'
  - `status` 'active' | 'disabled'
  - `scale` 1 | 2 | 3 | 4
  - `rate_limit` boolean — Whether per-IP rate limiting is enabled
  - `max_renders` integer, nullable
  - `render_count` integer
  - `expires_at` string, date-time, nullable
  - `base_url` string, uri
  - `sample_url` string, uri
  - `created_at` string, date-time
  - `signing_key` string — HMAC signing key. Only returned at creation time — store it now.

## Other responses

- `402` — Trial cap hit — upgrade required
- `422` — Validation failure — e.g. missing name/template, invalid enum value

---

[API](https://skmtc.dev/bannerbear/apis/bannerbear-v5-api.md) · [All operations](https://skmtc.dev/bannerbear/apis/bannerbear-v5-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bannerbear/bannerbear-v5-api/revisions/6aa425420a10/schema)