▣ IMAGE PROCESSING · SMART GENERATION

Generate QR Code API

What it does

QR Code Generator creates downloadable QR codes from plain text, URLs, vCard details, or Wi‑Fi credentials. Send one of those inputs in the request body, and you get back either a pre-signed cloud storage URL or a binary file, depending on the endpoint you use.

Use content to encode raw text or a URL, v_card to generate a contact QR code, or wifi_info to produce a Wi‑Fi login code. The request body also supports optional QR styling: logo for a center overlay image, foreground_color and background_color for color control, is_gradient for gradient foregrounds, and recovery_level for error correction tuning. For contact cards, v_card accepts fields such as name, phone_numbers, email, website, address, organization, and related profile details.

Choose the /link endpoint when you want a cloud-hosted image reference in the response. Choose /download when you want the QR code file returned directly as binary data. That makes QR Code Generator fit workflows like event badges, business cards, onboarding handouts, printed menus, and captive Wi‑Fi access points.

The response is simple: a URL for hosted delivery, or a file download for immediate use. If you are generating QR codes inside an app, CMS, or print pipeline, this keeps the integration focused on the data you already have and the output format you need.

▣ ENDPOINT 01 / 02

POST

Generate QR code — return cloud link

https://api.eu.apyverse.com/apyhub/generate-qr-code/link

QUICKSTART

GUIDE

Quickstart

Generate a QR code from simple text or a URL, and get back a pre-signed file URL.

curl -X POST "https://api.eu.apyverse.com/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 the pre-signed cloud storage URL for the generated file.

{
  "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 from one of the supported inputs and returns a cloud storage link to the generated file. The request body accepts QR content as raw text/URL, a vCard object, or Wi‑Fi credentials, plus optional styling fields.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	String	No	The output identifier for the generated QR code.

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 for the QR code. 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. Must be an email format.
v_card.notes	String	No	Additional notes.
v_card.address	String	No	Address.
v_card.website	String	No	Website URL. Must be a URI.
v_card.birthday	String	No	Birthday string.
v_card.job_title	String	No	Job title.
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 number list.
v_card.social_profiles	Object	No	Social profile links.
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 credentials for the QR code. Exactly one of `content`, `v_card`, or `wifi_info` must be provided.
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 network is hidden. Defaults to `false`.
is_gradient	Boolean	No	Must be `true` when `foreground_color` is an array. Defaults to `false`.
recovery_level	ENUM	No	Error correction level. Allowed values: `low`, `medium`, `high`, `highest`. Defaults to `highest`.
background_color	String	No	Hex background color. Required when `foreground_color` is set.
foreground_color	String	No	Foreground color. Can be a single hex string for solid mode, or an array of two hex strings for gradient mode. Must be omitted together with `background_color`, or both provided.

Response

Returns a JSON object with a data string field containing a pre-signed cloud storage URL for the generated file. The success response is represented as an object with a single top-level data field.

Parameter	Type	Mandatory	Description
data	String	No	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.

▣ ENDPOINT 02 / 02

POST

Generate QR code — download file

https://api.eu.apyverse.com/apyhub/generate-qr-code/download

QUICKSTART

GUIDE

Quickstart

Download a generated QR code by sending the content to encode and a filename for the output.

curl -X POST "https://api.eu.apyverse.com/apyhub/generate-qr-code/download?output=my-invite" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "https://apyhub.com"
  }'

What you'll get back

Returns a binary file stream (string with format: binary) containing the generated QR code image.

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 downloads it as a binary file. The request body supplies the QR content or a preset payload (content, v_card, or wifi_info), along with optional styling and logo settings.

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 payload. Exactly one of `content`, `v_card`, or `wifi_info` must be provided. Includes `name` and `phone_numbers`, and may include `email`, `notes`, `address`, `website`, `birthday`, `job_title`, `photo_url`, `organization`, and `social_profiles`.
v_card.name	String	Yes	Contact name.
v_card.email	String	No	Email address. Must be an email format.
v_card.notes	String	No	Notes for the contact.
v_card.address	String	No	Address for the contact.
v_card.website	String	No	Website URL. Must be a URI.
v_card.birthday	String	No	Birthday value.
v_card.job_title	String	No	Job title.
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 number list.
v_card.social_profiles	Object	No	Social profile links. Includes `twitter` and `linkedIn`.
v_card.social_profiles.twitter	String	No	Twitter profile value.
v_card.social_profiles.linkedIn	String	No	LinkedIn profile value.
content	String	No	Raw text or URL to encode. Max 2953 characters.
wifi_info	Object	No	Wi-Fi payload. Exactly one of `content`, `v_card`, or `wifi_info` must be provided. Includes required `ssid`, and may include `password`, `auth_type`, and `is_hidden`.
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 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`.
background_color	String	No	Hex background color. Required when `foreground_color` is set.
foreground_color	ENUM	No	Solid mode: a hex string such as `000000`. Gradient mode: an array of two hex strings `[startColor, endColor]` with exactly 2 items. Must be omitted together with `background_color`, or both provided.

Response

Returns a binary file download. The success response is a single binary payload, not a JSON object.

Parameter	Type	Mandatory	Description
binary	String	Yes	Binary QR code file content returned by the endpoint.

Notes

Exactly one of content, v_card, or wifi_info must be provided. Styling fields also have coupling rules: is_gradient must be true when foreground_color is an array, background_color is required when foreground_color is set, and foreground_color / background_color must be supplied together or omitted together.

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.