{ "openapi": "3.0.1", "info": { "title": "Awesome QR Code Api Actor", "description": "The Awesome QR Code API actor is a utility-focused automation designed to programmatically generate QR codes with extensive customization options. It enables developers, integrators, and automation workflows to create high-quality QR codes on demand without manual design tools.", "version": "0.0", "x-build-id": "1aQPJz7KvhwfwSl0Q" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/amaranth_nylon~QR-code-api-actor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-amaranth_nylon-QR-code-api-actor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/amaranth_nylon~QR-code-api-actor/runs": { "post": { "operationId": "runs-sync-amaranth_nylon-QR-code-api-actor", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/amaranth_nylon~QR-code-api-actor/run-sync": { "post": { "operationId": "run-sync-amaranth_nylon-QR-code-api-actor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "qrCodes": { "title": "QR Codes to Generate", "type": "array", "description": "Array of QR code configurations. Can be combined with batch import.", "items": { "type": "object", "properties": { "type": { "title": "QR Code Type", "type": "string", "description": "Type of QR code to generate", "enum": [ "url", "text", "email", "phone", "sms", "wifi", "vcard", "social", "geo", "location", "calendar", "event", "app", "app_store", "payment" ], "default": "url", "editor": "select" }, "content": { "title": "Content", "type": "string", "description": "The content to encode in the QR code", "editor": "textarea" }, "id": { "title": "Unique ID", "type": "string", "description": "Unique identifier for this QR code", "editor": "textfield" }, "template": { "title": "Template", "type": "string", "description": "Template to apply to this specific QR code (overrides global template)", "editor": "textfield" } }, "required": [ "type", "content" ] } }, "batchImport": { "title": "Batch Import Configuration", "type": "object", "description": "Import QR codes from CSV, JSON, or Apify storage", "properties": { "csvUrl": { "title": "CSV File URL", "type": "string", "description": "URL to CSV file", "editor": "textfield" }, "csvContent": { "title": "CSV Content", "type": "string", "description": "Direct CSV content", "editor": "textarea" }, "jsonUrl": { "title": "JSON File URL", "type": "string", "description": "URL to JSON file", "editor": "textfield" }, "jsonContent": { "title": "JSON Content", "type": "string", "description": "Direct JSON content", "editor": "textarea" }, "datasetId": { "title": "Dataset ID", "type": "string", "description": "Apify dataset ID to load from", "editor": "textfield" }, "kvStoreKey": { "title": "Key-Value Store Key", "type": "string", "description": "Key-Value Store key to load from", "editor": "textfield" } } }, "outputFormat": { "title": "Output Format", "enum": [ "png", "svg", "pdf", "all" ], "type": "string", "description": "Format for generated QR codes", "default": "png" }, "template": { "title": "Global Template", "enum": [ "", "BUSINESS_CARD", "CORPORATE", "VIBRANT", "GRADIENT_MODERN", "SOCIAL_MEDIA", "INSTAGRAM", "PRODUCT_TAG", "PROMOTIONAL", "EVENT_TICKET", "RESTAURANT_MENU", "PRINT_HIGH_QUALITY", "MINIMALIST", "WIFI_SHARING", "PAYMENT", "APP_DOWNLOAD" ], "type": "string", "description": "Apply a pre-designed template to all QR codes. Options: BUSINESS_CARD, CORPORATE, VIBRANT, GRADIENT_MODERN, SOCIAL_MEDIA, INSTAGRAM, PRODUCT_TAG, PROMOTIONAL, EVENT_TICKET, RESTAURANT_MENU, PRINT_HIGH_QUALITY, MINIMALIST, WIFI_SHARING, PAYMENT, APP_DOWNLOAD" }, "listTemplates": { "title": "List Available Templates", "type": "boolean", "description": "Display list of available templates in logs", "default": false }, "customization": { "title": "Customization Settings", "type": "object", "description": "Global customization applied to all QR codes (overrides template)", "properties": { "size": { "title": "QR Code Size", "type": "integer", "description": "Size in pixels", "default": 300, "minimum": 100, "maximum": 2000 }, "margin": { "title": "Margin", "type": "integer", "description": "White space margin", "default": 4, "minimum": 0, "maximum": 10 }, "errorCorrectionLevel": { "title": "Error Correction Level", "type": "string", "description": "Error correction level (L/M/Q/H)", "enum": [ "L", "M", "Q", "H" ], "default": "M" }, "foregroundColor": { "title": "Foreground Color", "type": "string", "description": "QR code foreground color (hex)", "default": "#000000", "pattern": "^#[0-9A-Fa-f]{6}$" }, "backgroundColor": { "title": "Background Color", "type": "string", "description": "QR code background color (hex)", "default": "#FFFFFF", "pattern": "^#[0-9A-Fa-f]{6}$" }, "logoUrl": { "title": "Logo URL", "type": "string", "description": "Logo image URL" }, "logoSize": { "title": "Logo Size", "type": "integer", "description": "Logo size percentage (10-40)", "default": 20, "minimum": 10, "maximum": 40 }, "style": { "title": "QR Code Style", "type": "string", "description": "QR code style: square, dots, rounded, extra-rounded, classy, classy-rounded", "enum": [ "square", "dots", "rounded", "extra-rounded", "classy", "classy-rounded" ] }, "gradientType": { "title": "Gradient Type", "type": "string", "description": "Gradient type", "enum": [ "none", "linear-vertical", "linear-horizontal", "radial" ] }, "gradientColors": { "title": "Gradient Colors", "type": "array", "description": "Array of hex colors for gradient (requires 2+ colors)", "items": { "type": "string", "pattern": "^#[0-9A-Fa-f]{6}$" } }, "frame": { "title": "Frame Style", "type": "string", "description": "Frame style", "enum": [ "none", "basic", "circular", "edge", "camera", "banner" ] }, "frameColor": { "title": "Frame Color", "type": "string", "description": "Frame color", "pattern": "^#[0-9A-Fa-f]{6}$" }, "frameText": { "title": "Frame Text", "type": "string", "description": "Text to display on frame" } } }, "urlShortening": { "title": "URL Shortening", "type": "object", "description": "Shorten URLs before encoding in QR codes", "properties": { "enabled": { "title": "Enable URL Shortening", "type": "boolean", "description": "Enable URL shortening", "default": false }, "service": { "title": "Shortening Service", "type": "string", "description": "URL shortening service", "enum": [ "isgd", "vgd", "tinyurl", "bitly", "cuttly" ], "default": "isgd" }, "apiKey": { "title": "API Key", "type": "string", "description": "API key (required for bitly, cuttly)" } } }, "trackingUrl": { "title": "Tracking Base URL", "type": "string", "description": "Base URL for tracking redirects (e.g., https://track.example.com/qr)" }, "validateQRCodes": { "title": "Validate QR Codes", "type": "boolean", "description": "Validate readability of generated QR codes", "default": false }, "exportZip": { "title": "Export ZIP Archive", "type": "object", "description": "Create ZIP archive of all generated QR codes", "properties": { "enabled": { "title": "Enable ZIP Export", "type": "boolean", "description": "Enable ZIP export", "default": false }, "organizeByType": { "title": "Organize by Type", "type": "boolean", "description": "Organize files by QR code type in ZIP", "default": false } } }, "exportCSV": { "title": "Export Results to CSV", "type": "boolean", "description": "Export results as CSV file", "default": false }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "URL to receive real-time notifications (progress, completion, etc.)" }, "enableAnalytics": { "title": "Enable Analytics Tracking", "type": "boolean", "description": "Include analytics metadata in output", "default": true }, "filenamePrefix": { "title": "Filename Prefix", "type": "string", "description": "Prefix for generated files", "default": "qr-code" }, "saveToKeyValueStore": { "title": "Save Files to Key-Value Store", "type": "boolean", "description": "Save generated files to Apify KV Store", "default": true }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum concurrent QR code generations", "default": 10 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }