Usage - Recraft

Dig into the details of using the Recraft API.

Generate image

Creates an image given a prompt.

POST https://external.api.recraft.ai/v1/images/generations

Example

response = client.images.generate(
    prompt='race car on a track',
    style='digital_illustration',
)
print(response.data[0].url)

Output

https://img.recraft.ai/-dSeKnnWTUbG9wnzpV6OjN7I7PlFxAFmg6nyhvd3qSE/rs:fit:1024:1024:0/raw:1/plain/abs://external/images/cbb1770e-3e7e-49fd-bf17-7c689f6906c1

Parameter	Type	Description
prompt (required)	string	A text description of the desired image(s). The maximum length is 1000 bytes.
text_layout	Array of objects or null	Available in `recraftv3` model only. This topic is covered below.
n	integer or null, default is 1	The number of images to generate, must be between 1 and 6.
style_id	UUID or null	Use a previously uploaded style as a reference, this topic is covered above and below.
style	string or null, default is `realistic_image`	The style of the generated images, this topic is covered above.
substyle	string or null	This topic is covered above.
model	string or null, default is `recraftv3`	The model to use for image generation. Must be one of `recraftv3` or `recraftv2`.
response_format	string or null, default is `url`	The format in which the generated images are returned. Must be one of `url` or `b64_json`.
size	string or null, default is `1024x1024`	The size of the generated images in `WxH` format, supported values are published below.
negative_prompt	string or null	A text description of undesired elements on an image.
controls	object or null	A set of custom parameters to tweak generation process, this topic is covered below.

Note: style_id and style parameters are mutually exclusive. If neither of the two parameters is specified, the default style of realistic_image will be used ‍Hint: if OpenAI Python Library is used, non-standard parameters can be passed using the extra_body argument. For example:

response = client.images.generate(
    prompt='race car on a track',
    extra_body={
        'style_id': style_id,
        'controls': {
            ...
        }
    }
)
print(response.data[0].url)

Create style

Upload a set of images to create a style reference.

POST https://external.api.recraft.ai/v1/styles

Example

response = client.post(
    path='/styles',
    cast_to=object,
    options={'headers': {'Content-Type': 'multipart/form-data'}},
    body={'style': 'digital_illustration'},
    files={'file1': open('image.png', 'rb')},
)
print(response['id'])

Output

{"id": "229b2a75-05e4-4580-85f9-b47ee521a00d"}

Request body

Upload a set of images to create a style reference.

Parameter	Type	Description
style (required)	string	The base style of the generated images, this topic is covered above.
files (required)	files	Images in PNG, JPG, or WEBP format for use as style references. The max number of images is 5. Total size of all images is limited to 5 MB.

Image to image

Image-to-image operation transforms an input image into an output image, preserving certain aspects while altering others based on the prompt.

POST https://external.api.recraft.ai/v1/images/imageToImage

Example

response = client.post(
    path='/images/imageToImage',
    cast_to=object,
    options={'headers': {'Content-Type': 'multipart/form-data'}},
    files={
        'image': open('image.png', 'rb'),
    },
    body={
        'prompt': 'winter',
        'strength': 0.2,
    },
)
print(response['data'][0]['url'])

Output

https://img.recraft.ai/f1LAVICjQjTDUbVlwlA4AbE_JBjEQU2t6ho6YhI0J8M/rs:fit:1024:1024:0/raw:1/plain/abs://external/images/6d85db5d-912f-4711-957c-15cbebc8cb24

Parameters

Parameter	Type	Description
image (required)	file	An image to modify, must be less than 5 MB in size, have resolution less than 16 MP, and max dimension less than 4096 pixels.
prompt (required)	string	A text description of areas to change. The maximum length is 1000 bytes.
strength (required)	float	Defines the difference with the original image, should lie in `[0, 1]`, where `0` means almost identical, and `1` means minimal similarity.
n	integer or null, default is 1	The number of images to generate, must be between 1 and 6.
style_id	UUID or null	Use a previously uploaded style as a reference, this topic is covered above and below.
style	string or null, default is `realistic_image`	The style of the generated images, this topic is covered above.
substyle	string or null	This topic is covered above.
model	string or null, default is `recraftv3`	The model to use for image generation. Only `recraftv3` is supported at the moment.
response_format	string or null, default is `url`	The format in which the generated images are returned. Must be one of `url` or `b64_json`.
negative_prompt	string or null	A text description of undesired elements on an image.
controls	object or null	A set of custom parameters to tweak generation process, this topic is covered below.

Note: style_id and style parameters are mutually exclusive. If neither of the two parameters is specified, the default style of “any" will be used

Image inpainting

Inpainting replaces or modifies specific parts of an image. It uses a mask to identify the areas to be filled in, where white pixels represent the regions to inpaint, and black pixels indicate the areas to keep intact, i.e. the white pixels are filled based on the input provided in the prompt.

POST https://external.api.recraft.ai/v1/images/inpaint

Example

response = client.post(
    path='/images/inpaint',
    cast_to=object,
    options={'headers': {'Content-Type': 'multipart/form-data'}},
    files={
        'image': open('image.png', 'rb'),
        'mask': open('mask.png', 'rb'),
    },
    body={
        'prompt': 'winter',
    },
)
print(response['data'][0]['url'])

Output

https://img.recraft.ai/HMd15RTSXeRfEluSPq828pZ7DW9NaI4oR2adSVk_wXc/rs:fit:1024:1024:0/raw:1/plain/abs://external/images/a97b9cc2-4498-41d8-9904-1d58e04b239b

Parameters

Body of a request should contains an image file and a mask in PNG, JPG or WEBP format and parameters passed as content type 'multipart/form-data'. The image must be no more than 5 MB in size, have resolution no more than 16 MP, max dimension no more than 4096 pixels and min dimension no less than 256 pixels.

Parameter	Type	Description
image (required)	file	An image to modify, must be less than 5 MB in size, have resolution less than 16 MP, and max dimension less than 4096 pixels.
mask (required)	file	An image encoded in grayscale color mode, used to define the specific regions of an image that need modification. The white pixels represent the parts of the image that will be inpainted, while black pixels indicate the parts of the image that will remain unchanged. Should have exactly the same size as the image. Each pixel of the image should be either pure black (value `0`) or pure white (value `255`).
prompt (required)	string	A text description of areas to change. The maximum length is 1000 bytes.
n	integer or null, default is 1	The number of images to generate, must be between 1 and 6.
style_id	UUID or null	Use a previously uploaded style as a reference, this topic is covered above and below.
style	string or null, default is `realistic_image`	The style of the generated images, this topic is covered above.
substyle	string or null	This topic is covered above.
model	string or null, default is `recraftv3`	The model to use for image generation. Only `recraftv3` is supported at the moment.
response_format	string or null, default is `url`	The format in which the generated images are returned. Must be one of `url` or `b64_json`.
negative_prompt	string or null	A text description of undesired elements on an image.

Note: style_id and style parameters are mutually exclusive. If neither of the two parameters is specified, the default style of “any" will be used

Replace background

Replace Background operation detects background of an image and modifies it according to given prompt.

POST https://external.api.recraft.ai/v1/images/replaceBackground

Example

response = client.post(
    path='/images/replaceBackground',
    cast_to=object,
    options={'headers': {'Content-Type': 'multipart/form-data'}},
    files={
        'image': open('image.png', 'rb'),
    },
    body={
        'prompt': 'winter',
    },
)
print(response['data'][0]['url'])

Output

https://img.recraft.ai/59eRxsKN87Tr-LLFleTm01RZSsSTuoZcHTzT9b1r_XM/rs:fit:1024:1024:0/raw:1/plain/abs://external/images/234453e8-6abf-472f-9ac7-9b8c7eca2f80

Parameters

Body of a request should contains an image file in PNG, JPG or WEBP format and parameters passed as content type 'multipart/form-data'. The image must be no more than 5 MB in size, have resolution no more than 16 MP, max dimension no more than 4096 pixels and min dimension no less than 256 pixels.

Parameter	Type	Description
image (required)	file	An image to modify, must be less than 5 MB in size, have resolution less than 16 MP, and max dimension less than 4096 pixels.
prompt (required)	string	A text description of areas to change. The maximum length is 1000 bytes.
n	integer or null, default is 1	The number of images to generate, must be between 1 and 6.
style_id	UUID or null	Use a previously uploaded style as a reference, this topic is covered above and below.
style	string or null, default is `realistic_image`	The style of the generated images, this topic is covered above.
substyle	string or null	This topic is covered above.
model	string or null, default is `recraftv3`	The model to use for image generation. Only `recraftv3` is supported at the moment.
response_format	string or null, default is `url`	The format in which the generated images are returned. Must be one of `url` or `b64_json`.
negative_prompt	string or null	A text description of undesired elements on an image.

Note: style_id and style parameters are mutually exclusive. If neither of the two parameters is specified, the default style of “any" will be used

Vectorize image

Converts a given raster image to SVG format.

POST https://external.api.recraft.ai/v1/images/vectorize

Example

response = client.post(
    path='/images/vectorize',
    cast_to=object,
    options={'headers': {'Content-Type': 'multipart/form-data'}},
    files={'file': open('image.png', 'rb')},
)
print(response['image']['url'])

Output

https://img.recraft.ai/fZm6nwEjI9Qy94LukIKbxRm4w2i5crwqu459qKg7ZWY/rs:fit:1341:1341:0/raw:1/plain/abs://external/images/2835e19f-282b-419b-b80c-9231a3d51517

Parameters

Body of a request should be a file in PNG, JPG or WEBP format and parameters passed as content type 'multipart/form-data'. The image must be no more than 5 MB in size, have resolution no more than 16 MP, max dimension no more than 4096 pixels and min dimension no less than 256 pixels.

Parameter	Type	Description
response_format	string or null, default is `url`	The format in which the generated images are returned. Must be one of `url` or `b64_json`.

Remove background

Removes background of a given raster image.

POST https://external.api.recraft.ai/v1/images/removeBackground

Example

response = client.post(
    path='/images/removeBackground',
    cast_to=object,
    options={'headers': {'Content-Type': 'multipart/form-data'}},
    files={'file': open('image.png', 'rb')},
)
print(response['image']['url'])

Output

https://img.recraft.ai/EYOLjpky-2-uClelfP61kzK-SEpIhKgLfjLFFGxmM_U/rs:fit:0:0:0/raw:1/plain/abs://external/images/e2d0cba6-12df-4141-aa21-43bfd5889990

Parameters

Parameter	Type	Description
response_format	string or null, default is `url`	The format in which the generated images are returned. Must be one of `url` or `b64_json`.

Crisp upscale

Enhances a given raster image using ‘crisp upscale’ tool, increasing image resolution, making the image sharper and cleaner.

POST https://external.api.recraft.ai/v1/images/crispUpscale

Example

response = client.post(
    path='/images/crispUpscale',
    cast_to=object,
    options={'headers': {'Content-Type': 'multipart/form-data'}},
    files={'file': open('image.png', 'rb')},
)
print(response['image']['url'])

Output

https://img.recraft.ai/LtCo_bs3chC8zhrku0CWLpCBKv4iOODprEdeD_MY1dw/rs:fit:1760:2348:0/raw:1/plain/abs://external/images/f7d01b15-0eba-4439-a5fb-38af38fb524e

Request body

Body of a request should be a file in PNG, JPG or WEBP format and parameters passed as content type multipart/form-data. The image must be no more than 5 MB in size, have resolution no more than 4 MP, max dimension no more than 4096 pixels and min dimension no less than 32 pixels.

Parameter	Type	Description
response_format	string or null, default is `url`	The format in which the generated images are returned. Must be one of `url` or `b64_json`.

Creative upscale

Enhances a given raster image using ‘creative upscale’ tool, boosting resolution with a focus on refining small details and faces.

POST https://external.api.recraft.ai/v1/images/creativeUpscale

Example

response = client.post(
    path='/images/creativeUpscale',
    cast_to=object,
    options={'headers': {'Content-Type': 'multipart/form-data'}},
    files={'file': open('image.png', 'rb')},
)
print(response['image']['url'])

Output

https://img.recraft.ai/DV4d9pMeq5lIluqS7m8qHyg-mb6hf5uCqEPPC8t8wy4/rs:fit:4740:3536:0/raw:1/plain/abs://external/images/fb576169-8a66-4270-a566-35713ad72020

Request body

Body of a request should be a file in PNG, JPG or WEBP format and parameters passed as content type multipart/form-data. The image must be no more than 5 MB in size, have resolution no more than 16 MP, max dimension no more than 4096 pixels and min dimension no less than 256 pixels.

Parameter	Type	Description
response_format	string or null, default is `url`	The format in which the generated images are returned. Must be one of `url` or `b64_json`.

Get user information

Returns information of the current user including credits balance.

GET https://external.api.recraft.ai/v1/users/me

Example

response = client.get(path='/users/me', cast_to=object)
print(response)

Output

{
    "credits": 1000,
    "email": "test@example.com",
    "id": "c18a1988-45e7-4c00-82c4-4ad7d3dbce3a",
    "name": "Recraft Test"
}

Auxiliary

Controls

The generation process can be adjusted with a number of tweaks.

Parameter	Type	Description
artistic_level	integer or null	Defines the artistic tone of your image. At a simple level, the person looks straight at the camera in a static and clean style. Dynamic and eccentric levels introduce movement and creativity. The value should be in the range `[0..5]`.
colors	array of color definitions	An array of preferable colors.
background_color	color definition	Use the given color as a desired background color.
no_text	bool	Do not embed text layouts.

Colors

Color type is defined as an object with the following fields | rgb (required) | An array of 3 integer values in range of 0...255 defining RGB color model. | Example

response = client.images.generate(
    prompt='race car on a track',
    style='realistic_image',
    extra_body={
        'controls': {
            'colors': [
                {'rgb': [0, 255, 0]}
            ]
        }
    }
)
print(response.data[0].url)

Text Layout

Text layout is used to define spatial and textual attributes for individual text elements. Each text element consists of an individual word and its bounding box (bbox). | text (required) | A single word containing only supported characters. | | bbox (required) | A bounding box representing a 4-angled polygon. Each point in the polygon is defined by relative coordinates. | Bounding box: The bounding box (bbox) is a list of 4 points representing a 4-angled figure (not necessarily a rectangle). Each point specifies its coordinates relative to the layout dimensions, where (0, 0) is the top-left corner, (1, 1) is the bottom-right corner.** Coordinates**: Coordinates are relative to the layout dimensions. Coordinates can extend beyond the [0, 1] range, such values indicate that the shape will be cropped.
‍
‍Points: The bounding box must always have exactly 4 points. Each point is an array of two floats [x, y] representing the relative position. Supported characters The text field must contain a single word composed only of the following characters:

! " # $ % & ' ( ) * + , - . / 
0 1 2 3 4 5 6 7 8 9 
: ; < > ? @ 
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 
_ { } 
Ø Đ Ħ Ł Ŋ Ŧ 
Α Β Ε Ζ Η Ι Κ Μ Ν Ο Ρ Τ Υ Χ 
І 
А В Е К М Н О Р С Т У Х 
ß ẞ

Any character not listed above will result in validation errors. Example

response = client.images.generate(
    prompt="cute red panda with a sign",
    style="digital_illustration",
    extra_body={
        "text_layout": [
            {
                "text": "Recraft",
                "bbox": [[0.3, 0.45], [0.6, 0.45], [0.6, 0.55], [0.3, 0.55]],
            },
            {
                "text": "AI",
                "bbox": [[0.62, 0.45], [0.70, 0.45], [0.70, 0.55], [0.62, 0.55]],
            },
        ]
    },
)
print(response.data[0].url)

API

​Generate image

​Example

​Output

​Create style

​Example

​Output

​Request body

​Image to image

​Example

​Output

​Parameters

​Image inpainting

​Example

​Output

​Parameters

​Replace background

​Example

​Output

​Parameters

​Vectorize image

​Example

​Output

​Parameters

​Remove background

​Example

​Output

​Parameters

​Crisp upscale

​Example

​Output

​Request body

​Creative upscale

​Example

​Output

​Request body

​Get user information

​Example

​Output

​Auxiliary

​Controls

​Colors

​Text Layout

Generate image

Example

Output

Create style

Example

Output

Request body

Image to image

Example

Output

Parameters

Image inpainting

Example

Output

Parameters

Replace background

Example

Output

Parameters

Vectorize image

Example

Output

Parameters

Remove background

Example

Output

Parameters

Crisp upscale

Example

Output

Request body

Creative upscale

Example

Output

Request body

Get user information

Example

Output

Auxiliary

Controls

Colors

Text Layout