Get QR Code

https://appwrite.io/v1/avatars/qr

Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image.

Access Token Required: API Key

Query Params

textstringrequired

Plain text to be converted to QR code image.

sizeintegerDefault: 400

QR code size. Pass an integer between 0 to 1000. Defaults to 400.

marginintegerDefault: 1

Margin from edge. Pass an integer between 0 to 10. Defaults to 1.

downloadbooleanDefault: false

Return resulting image with 'Content-Disposition: attachment ' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://appwrite.io/v1/avatars/qr' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET