canonical: https://jentic.com/apis/qrx.codes/qrx

# Qrx Codes QRX API

The QRX API makes picture QR codes: you send a prompt describing what the image should show plus a destination link, or Wi-Fi details on the Starter plan, and QRX paints a scannable code in that scene. Codes are made asynchronously, so creation returns an id, a shortUrl, and a processing status at once, and the wait parameter can hold the request open until the image is ready. Link codes can be re-pointed after printing, and the account endpoint reports the plan, codes left today, and rate limits.

## For AI agents

Create picture QR codes from a text prompt and a destination link or Wi-Fi network, wait for or poll the finished image, re-point link codes, and check the account's daily allowance and rate limits.

## Scope

Does not track scan analytics, shorten arbitrary links, or print materials. Use for generating and re-pointing prompt-painted QR codes only.

## Capabilities

- Create a picture QR code from a prompt and a destination URL, optionally in a style from the styles list
- Create a Wi-Fi QR code with ssid, password, and wpa or wep security on the Starter plan
- Wait up to 50 seconds for a code to finish with the wait parameter instead of polling
- Send an Idempotency-Key so a retried create cannot produce a second code
- Re-point a link code's destination after printing so scans follow at once
- Check the plan, remainingToday, resetsAt, and rateLimits on the account

## Use cases

### Agent-made picture QR codes through Jentic

A design or marketing agent produces on-brand QR art for a campaign: it lists styles, creates a code from a prompt and destination with an Idempotency-Key, and waits for the image. Through Jentic the qrx_live_ key is injected by the developer's own Jentic One instance, so the agent never holds it.

Example prompt: GET `/v1/styles`, then POST `/v1/codes`?wait=45 with prompt 'A lighthouse on a cliff at sunset', destination 'https://example.com/menu', and an Idempotency-Key header

### Branded Wi-Fi codes for venues

Cafes and hotels print Wi-Fi codes on table cards. On the Starter plan, a create request with a wifi object of ssid, password, and security produces a code that joins the network, painted in a scene that matches the venue.

Example prompt: POST `/v1/codes` with prompt 'A cosy coffee shop counter' and wifi {ssid 'CafeGuest', password 'latte2026', security 'wpa'}

### Re-pointing printed codes

PATCH `/v1/codes/{id}` changes a link code's destination on the Starter plan, and printed codes follow at once, so a poster can move from a launch page to an order page without reprinting.

Example prompt: PATCH `/v1/codes/{id}` with destination 'https://example.com/new-menu'

### Allowance-aware batch creation

Every API code counts against the plan's daily allowance. GET `/v1/account` returns dailyLimit, remainingToday, resetsAt, and the rateLimits object, so an agent can pace a batch and stop before the allowance runs out.

Example prompt: GET `/v1/account`, read codes.remainingToday, and create at most that many codes with POST `/v1/codes`

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/v1/codes` | Create a code |
| GET | `/v1/codes/{id}` | Get a code's status and image |
| PATCH | `/v1/codes/{id}` | Change where a code points |
| GET | `/v1/codes` | List codes |
| GET | `/v1/styles` | List styles |
| GET | `/v1/account` | Get the account |

## Key resources

- **Codes** — Create, list, get with optional wait, and re-point picture QR codes
- **Styles** — Styles a code can be painted in, with preview images
- **Account** — Plan, features, daily allowance, rate limits, and credentials in use

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 79 / 100
- **Maturity:** AI-Ready
- **Dimensions:**
  - Foundational Compliance: 93 / 100
  - Developer Experience & Jentic Compatibility: 74 / 100
  - AI-Readiness & Agent Experience: 86 / 100
  - Agent Usability: 94 / 100
  - Security: 55 / 100
  - AI Discoverability: 69 / 100
- **View full report:** https://jentic.com/apis/qrx.codes/qrx/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring QRX by hand means choosing between its bearer and X-API-Key header forms, generating Idempotency-Key values for safe retries, and handling the asynchronous create with wait or polling yourself. Through Jentic you install once, import QRX from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** QRX puts the code id in the URL path (`/v1/codes/{id}`), so a rule can pin your agent to one code: it can read or re-point that code and nothing else. You choose the operations it may call, so re-pointing printed codes is not included unless you add it.
- **Credential handling:** Your QRX key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a picture QR code' or 'check codes left today', and Jentic returns the matching QRX operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **QR Code Generator API** — Conventional QR code generation service
- **QRCode Monkey API** — Custom-designed QR codes with logos and colours
- **Bitly API** — Link shortening with click analytics

## FAQ

### What authentication does the QRX API use?

The QRX API declares two schemes for the same API key: bearerAuth, sending the qrx_live_ key as an Authorization bearer token (preferred), and apiKeyHeader, sending it in an X-API-Key header for clients that cannot set an authorisation scheme. Through Jentic the key is stored encrypted by your own Jentic One instance and injected at execution time.

### How do I know when a QRX code is ready?

Creation is asynchronous: POST `/v1/codes` answers 202 with the code processing. Pass wait (up to 50) to hold the request open until it finishes, or call GET `/v1/codes/{id}` with wait to get the status and, once it has succeeded, the image.

### What are the rate limits for the QRX API?

The OpenAPI spec does not publish fixed numbers; GET `/v1/account` returns your live rateLimits, each with a limit and windowSeconds, plus the daily code allowance in dailyLimit and remainingToday. See https://qrx.codes/developers/docs for details.

### How do I create a picture QR code with QRX through Jentic?

Install Jentic One, import the QRX API from the Jentic API Directory, and store your qrx_live_ key. Your agent searches for 'create a picture QR code', Jentic returns POST `/v1/codes` with its schema, and the agent calls it with a prompt and destination. To run it on your own infrastructure, install Jentic One from its GitHub repo.

### Is there a QRX MCP server?

You don't need an MCP server to give your agent QRX. Jentic connects it directly from the API Directory: import it, store your credential once, and your agent calls it, discovering operations on demand rather than loading every tool definition into its context.

### Can I limit what my agent is allowed to do with the QRX API?

Yes. Write a rule that allows only POST `/v1/codes`, GET `/v1/codes/{id}`, and GET `/v1/styles`, so the agent can create new codes and fetch them while re-pointing existing printed codes stays out of reach. Every call it makes is logged.