---
title: "Build the standard WIFI: payload string for a WiFi QR code."
method: POST
path: "/api/v1/wifi-qr"
tags: ["Web Tools"]
---

# Build the standard WIFI: payload string for a WiFi QR code.

`POST /api/v1/wifi-qr`

## Request

- Base URL: `https://programmes.net`
- URL: `https://programmes.net/api/v1/wifi-qr`
- Auth: none declared

WiFi QR Code Generator. Operations: `payload` — Build the WIFI: payload string a phone scans to auto-join a network.

## Request body

- WifiQrPayload: Build the WIFI: payload string a phone scans to auto-join a network.
  - `operation` 'payload', required
  - `input` string: The network SSID.
  - `options` object
    - `password` string: Network password.
    - `encryption` 'WPA' | 'WEP' | 'nopass': Encryption type.
    - `hidden` boolean: Hidden network flag.

## Response `200`

The operation ran.

- object
  - `ok` unknown, required
  - `tool` 'wifi-qr', required
  - `operation` 'payload', required
  - `result` unknown, required

## Other responses

- `400`: The request is not valid (https://programmes.net/api#invalid-request); The tool has no such operation (https://programmes.net/api#unknown-operation)
- `404`: No such tool (https://programmes.net/api#unknown-tool)
- `413`: The request or its input is too large (https://programmes.net/api#content-too-large)
- `415`: The body must be JSON (https://programmes.net/api#unsupported-media-type)
- `422`: An option is missing, of the wrong type or out of range (https://programmes.net/api#invalid-options); This call needs more CPU than one API call may use (https://programmes.net/api#refused); The operation could not process the input (https://programmes.net/api#tool-error)
- `429`: Too many requests (https://programmes.net/api#rate-limited)
- `500`: Internal error (https://programmes.net/api#internal-error)

---

[API](https://skmtc.dev/programmes/apis/programmes-net-api.md) · [All operations](https://skmtc.dev/programmes/apis/programmes-net-api/llms.txt) · [OpenAPI document](https://skmtc.dev/programmes/apis/programmes-net-api/revisions/aa939784a2e6?raw)