Skip to main content
POST

​
Description

Generate an icon from a text prompt.

Authorizations

​
x-magnific-api-key
string
header
required

Your Magnific API key. Required for authentication. Learn how to obtain an API key

Body

application/json
​
prompt
string
required

The prompt to generate the icon

Example:

"A cute cat icon"

​
webhook_url
string<uri>
required

The webhook URL to receive the result

Example:

"https://example.com/webhook"

​
style
enum<string>
default:solid

The style to use for the icon

Available options:
solid,
outline,
color,
flat,
sticker
Example:

"solid"

​
num_inference_steps
integer

The number of inference steps to use for the generation

Required range: 10 <= x <= 50
Example:

10

​
guidance_scale
number

The guidance scale to use for the generation

Required range: 0 <= x <= 10
Example:

7

​
format
enum<string>
default:png

The format of the icon

Available options:
png,
svg
Example:

"svg"

Response

Success - The request has succeeded and the Text to Icon process has started.

​
data
object
required
Example: