The create-a-qr-code API endpoint triggers the workflow to create a QR code. This endpoint allows you to generate QR codes programmatically by providing the necessary parameters in the request body.
This API endpoint is accessed using the POST method.
When you make a request to this endpoint, you should include the following query parameters:
api_token: Your access_token<aside> 💡 Go to this page to find out how to get the Access Token.
</aside>
| Name | Type | Required? | Description |
|---|---|---|---|
| qr_data | string |
Yes | The data or content to be encoded in the QR code. Shorter links give more visually appealing results. |
| prompt | string |
Yes | The prompt or input provided for the QR code generation. Describe the subject/scene of the QR Code. Choose clear prompts and distinguishable visuals to ensure optimal readability. |
| num_outputs | integer | Optional | Change the number of outputs for a single run here. |
| image_resolution | integer | Yes | The desired resolution or quality of the generated QR code image. |
Allowed values: 256, 512, 768 |
| scheduler | string | Yes | Allowed values: DDIM, DPMSolverMultistep, HeunDiscrete, K_EULER_ANCESTRAL, K_EULER , KLMS, PNDM, UniPCMultistep |
| num_inference_steps | integer | Yes | Denoising steps. The higher this number, the more detailed the inference made by the model, but it may require more processing time.
Min: 1 ⇒ Max: 1000 | | guidance_scale | decimal | Yes | How pressurized should the AI feel to produce what you want? How much creative freedom do you want the AI to have when interpreting your prompt?
Min: 1 ⇒ Max: 20 | | eta | integer | Optional | Controls the amount of noise that is added to the input data during the denoising diffusion process. Higher value -> more noise
Default value: 0 |
| seed | integer | Optional | The seed value used for generating random QR codes. |
| guess_mode | boolean | Optional | In this mode, the ControlNet encoder will try best to recognize the content of the input image even if you remove all prompts. The guidance_scale between 3.0 and 5.0 is recommended. |
| disable_safety_check | boolean | Optional | A flag indicating whether to disable safety checks during QR code generation. Disable safety check. Use at your own risk! |
| qr_conditioning_scale | decimal | Yes | At 0 the prompted visual will be intact and the QR code will be more artistic but less readable. At 2 the control settings that blend the QR code will be applied tightly, possibly overriding the image prompt, but the QR code will be more readable.
Min: 0 ⇒ Max: 2 | | negative_prompt | string | Optional | This allows you to specify what you don't want to see in your output. | | response_webhook_url | string | Optional | The webhook URL to be used for sending the response or result of the QR code generation. |
200: This status code indicates a successful workflow execution.400: This status code indicates an error in the workflow.401: This status code indicates an error in the workflow.403: This status code indicates an error in the workflow.404: This status code indicates an error in the workflow.500+: This status code indicates an error in the workflow.