▣ MARKETING · SMART GENERATION

Generate QR Code API

Hosted on ApyHub

What it does

QR Code Generator creates downloadable QR codes or a cloud-hosted QR image from plain text, a vCard, or Wi‑Fi details. Send one input type per request, and you get back a QR code asset you can place on tickets, packaging, business cards, menus, or onboarding materials.

Use content for raw text or a URL, v_card for contact-sharing QR codes, or wifi_info to encode network access details. The vCard payload supports name and phone_numbers as required fields, plus optional email, notes, address, website, birthday, job_title, photo_url, organization, and social_profiles. Wi‑Fi QR codes accept ssid and optional password, auth_type, and is_hidden.

You can also brand the QR code with a logo, choose foreground_color and background_color, enable is_gradient for two-color foregrounds, and set recovery_level to control error correction. The service enforces the payload rules in the schema, including the one-input requirement and the color combinations, so you can validate QR generation before you ship it into a workflow.

Choose /download when you need the generated file directly, or /link when you want a pre-signed cloud URL in the response.

▣ ENDPOINT 01 / 02

POST

Generate QR code — download file

http://localhost:8080/apyhub/generate-qr-code/download

QUICKSTARTGUIDE

Quickstart

Create a QR code download from raw text or a URL, and name the output via the required query parameter.

curl -X POST "http://localhost:8080/apyhub/generate-qr-code/download?output=my-invite" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"content":"https://apyhub.com","logo": "https://apyhub.com/logo.svg", }'

What you'll get back

Returns binary data (string with format: binary) — the downloaded QR code file itself.

TRY ITLIVE · 30 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

body*

Exactly one of `content`, `v_card`, or `wifi_info` must be provided.

logo

URL of an image to overlay in the centre of the QR code.

v_card

name

notes

address

website

birthday

job_title

photo_url

organization

phone_numbers

social_profiles

twitter

content

Raw text or URL to encode. Max 2953 characters.

wifi_info

ssid

password

auth_type

is_hidden

Must be true when foreground_color is an array. Returns 400 if true but foreground_color is not an array.

is_gradient

recovery_level

Error correction level. Lower = more content capacity, less damage tolerance.

background_color

Hex background color. Required when foreground_color is set.

foreground_color

Solid mode: hex string (e.g. "000000"). Gradient mode: array of two hex strings ["startColor", "endColor"]. Must be omitted together with background_color, or both provided.

foreground_color

output

About this endpoint

What it does

Generates a QR code and returns it as a downloadable binary file. The request body can encode either raw content, a vCard, or Wi‑Fi information, and supports optional styling such as logo overlay, colors, gradient mode, and error-correction level.

Request Body

Parameter	Type	Mandatory	Description
content	String	No	Raw text or URL to encode. Max 2953 characters. Exactly one of `content`, `v_card`, or `wifi_info` must be provided.
v_card	Object	No	vCard payload. Exactly one of `content`, `v_card`, or `wifi_info` must be provided.
v_card.name	String	Yes	Contact name.
v_card.email	String	No	Email address.
v_card.notes	String	No	Notes.
v_card.address	String	No	Address.
v_card.website	String	No	Website URL.
v_card.birthday	String	No	Birthday string.
v_card.job_title	String	No	Job title.
v_card.photo_url	String	No	Photo URL.
v_card.organization	String	No	Organization.
v_card.phone_numbers	String Array	Yes	Phone number list.
v_card.social_profiles	Object	No	Social profile links.
v_card.social_profiles.twitter	String	No	Twitter handle or URL.
v_card.social_profiles.linkedIn	String	No	LinkedIn profile.
wifi_info	Object	No	Wi‑Fi credentials payload. Exactly one of `content`, `v_card`, or `wifi_info` must be provided.
wifi_info.ssid	String	Yes	Wi‑Fi network name.
wifi_info.password	String	No	Wi‑Fi password.
wifi_info.auth_type	ENUM	No	Authentication type. Allowed values: `WEP`, `WPA`, `WPA2`, `WPA3`, `WPA-EAP`, `WPA2-EAP`, `WPA3-EAP`.
wifi_info.is_hidden	Boolean	No	Whether the network is hidden. Default: `false`.
logo	String	No	URL of an image to overlay in the centre of the QR code.
is_gradient	Boolean	No	Must be `true` when `foreground_color` is an array. Returns 400 if `true` but `foreground_color` is not an array. Default: `false`.
recovery_level	ENUM	No	Error correction level. Allowed values: `low`, `medium`, `high`, `highest`. Default: `highest`. Lower values increase content capacity but reduce damage tolerance.
background_color	String	No	Hex background color. Required when `foreground_color` is set.
foreground_color	String	No	Solid mode: hex string (for example `000000`). Gradient mode: array of two hex strings `[startColor, endColor]`. Must be omitted together with `background_color`, or both provided.

Response

Returns a binary file in the response body. The success response is a downloadable QR code file, with no JSON wrapper or named fields in the output schema.

Notes

Exactly one of content, v_card, or wifi_info must be provided. Also note that is_gradient must be true when foreground_color is an array, and background_color is required when foreground_color is set.

Query parameters

Name

Type

Description

outputOPTIONAL

string

—

Body

Name

Type

Description

bodyREQUIRED

object

Exactly one of `content`, `v_card`, or `wifi_info` must be provided.

▣ ENDPOINT 02 / 02

POST

Generate QR code — return cloud link

http://localhost:8080/apyhub/generate-qr-code/link

QUICKSTARTGUIDE

Quickstart

Generate a QR code from plain text by sending the content to encode.

curl -X POST "http://localhost:8080/apyhub/generate-qr-code/link" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "https://apyhub.com"
  }'

What you'll get back

Returns a JSON object with a data string field containing a pre-signed URL for the generated QR code image.

{
  "data": "https://storage.example.com/output_2025-06-15_abc123.png?sig=..."
}

TRY ITLIVE · 30 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

body*

Exactly one of `content`, `v_card`, or `wifi_info` must be provided.

logo

URL of an image to overlay in the centre of the QR code.

v_card

name

notes

address

website

birthday

job_title

photo_url

organization

phone_numbers

social_profiles

twitter

content

Raw text or URL to encode. Max 2953 characters.

wifi_info

ssid

password

auth_type

is_hidden

Must be true when foreground_color is an array. Returns 400 if true but foreground_color is not an array.

is_gradient

recovery_level

Error correction level. Lower = more content capacity, less damage tolerance.

background_color

Hex background color. Required when foreground_color is set.

foreground_color

Solid mode: hex string (e.g. "000000"). Gradient mode: array of two hex strings ["startColor", "endColor"]. Must be omitted together with background_color, or both provided.

foreground_color

output

About this endpoint

What it does

Generates a QR code and returns a JSON object containing a pre-signed cloud storage URL for the generated file. The request body must provide exactly one of content, v_card, or wifi_info, plus any optional styling fields you want to apply.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	String	No	Output format identifier. The schema provides a string example (`my-invite`), but no further constraints are declared.

Request Body

Parameter	Type	Mandatory	Description
logo	String	No	URL of an image to overlay in the centre of the QR code. Must be a URI.
v_card	Object	No	vCard content to encode. Exactly one of `content`, `v_card`, or `wifi_info` must be provided. Required fields: `name`, `phone_numbers`. See schema for nested fields.
v_card.name	String	Yes	Contact name.
v_card.email	String	No	Email address. Must be an email format string.
v_card.notes	String	No	Notes to include in the vCard.
v_card.address	String	No	Address to include in the vCard.
v_card.website	String	No	Website URL. Must be a URI.
v_card.birthday	String	No	Birthday string. The schema provides an example value (`1990-01-15`) but no format constraint beyond string is declared.
v_card.job_title	String	No	Job title to include in the vCard.
v_card.photo_url	String	No	Photo URL. Must be a URI.
v_card.organization	String	No	Organization name.
v_card.phone_numbers	String Array	Yes	Phone numbers to include in the vCard.
v_card.social_profiles	Object	No	Social profile links. See schema for nested fields.
v_card.social_profiles.twitter	String	No	Twitter profile identifier or URL.
v_card.social_profiles.linkedIn	String	No	LinkedIn profile identifier or URL.
content	String	No	Raw text or URL to encode. Max 2953 characters. Exactly one of `content`, `v_card`, or `wifi_info` must be provided.
wifi_info	Object	No	Wi-Fi network details to encode. Exactly one of `content`, `v_card`, or `wifi_info` must be provided. Required field: `ssid`. See schema for nested fields.
wifi_info.ssid	String	Yes	Wi-Fi network name (SSID).
wifi_info.password	String	No	Wi-Fi password.
wifi_info.auth_type	ENUM	No	Authentication type. Allowed values: `WEP`, `WPA`, `WPA2`, `WPA3`, `WPA-EAP`, `WPA2-EAP`, `WPA3-EAP`.
wifi_info.is_hidden	Boolean	No	Whether the Wi-Fi network is hidden. Default: `false`.
is_gradient	Boolean	No	Must be `true` when `foreground_color` is an array. Returns 400 if `true` but `foreground_color` is not an array. Default: `false`.
recovery_level	ENUM	No	Error correction level. Allowed values: `low`, `medium`, `high`, `highest`. Default: `highest`. Lower values increase content capacity and reduce damage tolerance.
background_color	String	No	Hex background color. Required when `foreground_color` is set.
foreground_color	String	No	Solid mode: hex string such as `000000`. Must be omitted together with `background_color`, or both provided.
foreground_color[]	String	No	Gradient mode: array of two hex strings (`startColor`, `endColor`). Must contain exactly 2 items.

Response

Returns a JSON object with a data string field. data is a pre-signed cloud storage URL for the generated file.

Parameter	Type	Mandatory	Description
data	String	Yes	Pre-signed cloud storage URL for the generated file.

Query parameters

Name

Type

Description

outputOPTIONAL

string

—

Body

Name

Type

Description

bodyREQUIRED

object

Exactly one of `content`, `v_card`, or `wifi_info` must be provided.

▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.