Recraft

https://www.recraft.ai/docs
Admin
Recraft is an advanced AI image generation platform that creates high-fidelity raster and vector...
Tokens:189,097
Snippets:1,347
Trust Score:10
Update:23 hours ago
Show doc for...
Tokens:
Raw
### Get user information with cURL (full example)

Source: https://www.recraft.ai/docs/api-reference/endpoints

Uses cURL to fetch the current user's information. Requires the RECRAFT_API_TOKEN environment variable.

```bash
curl https://external.api.recraft.ai/v1/users/me \
  -H "Authorization: Bearer $RECRAFT_API_TOKEN"
```

--------------------------------

### Response for get user information

Source: https://www.recraft.ai/docs/api-reference/endpoints

Example JSON response from the /users/me endpoint, showing credits, email, id, and name.

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

--------------------------------

### Create style - Response example

Source: https://www.recraft.ai/docs/api-reference/endpoints

Example JSON response from the POST /v1/styles endpoint, containing the style ID, style type, creation time, privacy flag, and credits used.

```json
{
    "id": "229b2a75-05e4-4580-85f9-b47ee521a00d",
    "style": "any",
    "creation_time": "2024-01-01T00:00:00Z",
    "is_private": true,
    "credits": 5
}
```

--------------------------------

### GET /styles/basic

Source: https://www.recraft.ai/docs/api-reference/endpoints

Lists basic predefined styles.

```APIDOC
## GET /styles/basic

### Description
Lists basic predefined styles.

### Method
GET

### Endpoint
/styles/basic

### Authentication
Requires `Authorization: Bearer RECRAFT_API_TOKEN` header.

### Response
#### Success Response (200)
- **data** (array) - List of basic style objects.

#### Response Example
{
  "data": [
    {
      "id": "basic_style_1",
      "name": "Basic Style"
    }
  ]
}
```

--------------------------------

### Python requests example for crisp upscale

Source: https://www.recraft.ai/docs/api-reference/tools/upscale

Uses the requests library to POST to the crispUpscale endpoint. Prints the resulting image URL or exits with an error on failure.

```python
# pip install requests
import os

import requests

response = requests.post(
    'https://external.api.recraft.ai/v1/images/crispUpscale',
    headers={'Authorization': f"Bearer {os.environ['RECRAFT_API_TOKEN']}"},
    json={
        'image_url': 'https://cdn.prod.website-files.com/655727fe69827d9a402de12c/679b82f54ef9617939df9d8e_motorcycle--going-fast.png',
    },
)
if not response.ok:
    raise SystemExit(f'{response.status_code}: {response.text}')
print(response.json()['image']['url'])
```

--------------------------------

### POST /v1/styles with palette

Source: https://www.recraft.ai/docs/api-reference/endpoints

Example of creating a style with a stored color palette using multipart or JSON requests.

```APIDOC
## POST /v1/styles

### Description
Creates a style with an optional color palette. The palette is passed as repeated fields in multipart requests or as a JSON object.

### Method
POST

### Endpoint
https://external.api.recraft.ai/v1/styles

### Parameters
#### Request Body (Multipart)
- **model** (string) - Required - Model identifier, e.g., 'recraftv4_styles'.
- **palette[colors][][rgb][]** (array of integers) - Optional - RGB values for each color in the palette.
- **palette[background_color][rgb][]** (array of integers) - Optional - RGB values for the background color.
- **file1** (file) - Required - Image file to use for style creation.

#### Request Body (JSON)
- **model** (string) - Required - Model identifier.
- **palette** (object) - Optional - Color palette.
  - **colors** (array of color definitions) - Optional - Each with **rgb** and optional **weight**.
  - **background_color** (color definition) - Optional - With **rgb** field.

### Request Example (Multipart)
model=recraftv4_styles&palette[colors][][rgb][]=0&palette[colors][][rgb][]=255&palette[colors][][rgb][]=0&palette[colors][][rgb][]=255&palette[colors][][rgb][]=0&palette[colors][][rgb][]=0&palette[background_color][rgb][]=40&palette[background_color][rgb][]=40&palette[background_color][rgb][]=40

### Response
#### Success Response (200)
- **id** (string) - The ID of the created style.

#### Response Example
{
  "id": "style_id"
}
```

--------------------------------

### POST /v1/images/imageToImage (OpenAI-compatible client)

Source: https://www.recraft.ai/docs/api-reference/examples

Python example using the OpenAI client with a custom base URL to call the image-to-image endpoint.

```APIDOC
## POST /v1/images/imageToImage

### Description
Generates a new image based on an input image URL, a prompt, and a style using the OpenAI-compatible client.

### Method
POST

### Endpoint
https://external.api.recraft.ai/v1/images/imageToImage

### Parameters
#### Request Body (JSON)
- **image_url** (string) - Required - URL of the input image.
- **prompt** (string) - Required - Text prompt describing the desired transformation.
- **strength** (number) - Optional - Strength of the transformation (e.g., 0.2).
- **style** (string) - Optional - Curated style name (e.g., "Illustration").

### Request Example
```python
# pip install openai
import os

from openai import OpenAI

client = OpenAI(
    base_url='https://external.api.recraft.ai/v1',
    api_key=os.environ['RECRAFT_API_TOKEN'],
)

response = client.post(
    path='/images/imageToImage',
    cast_to=object,
    body={
        'image_url': 'https://example.com/image.png',
        'prompt': 'winter',
        'strength': 0.2,
        'style': 'Illustration',
    },
)
print(response['data'][0]['url'])
```

### Response
#### Success Response (200)
- **data[0].url** (string) - URL of the generated image.

#### Response Example
```json
{
  "data": [
    {
      "url": "https://example.com/generated-image.png"
    }
  ]
}
```
```

--------------------------------

### Generate image with Python (requests)

Source: https://www.recraft.ai/docs/api-reference/getting-started

Python example using the requests library. Requires the requests package. Prints the URL of the generated image.

```python
# pip install requests
import os

import requests

response = requests.post(
    'https://external.api.recraft.ai/v1/images/generations',
    headers={'Authorization': f"Bearer {os.environ['RECRAFT_API_TOKEN']}"},
    json={'prompt': 'two race cars on a track'},
)
if not response.ok:
    raise SystemExit(f'{response.status_code}: {response.text}')
print(response.json()['data'][0]['url'])
```

--------------------------------

### POST /v1/images/imageToImage (Python requests)

Source: https://www.recraft.ai/docs/api-reference/examples

Python example using the requests library to call the image-to-image endpoint with multipart/form-data.

```APIDOC
## POST /v1/images/imageToImage

### Description
Generates a new image based on an input image, a prompt, and a style using Python requests.

### Method
POST

### Endpoint
https://external.api.recraft.ai/v1/images/imageToImage

### Parameters
#### Request Body (multipart/form-data)
- **image** (file) - Required - The input image file.
- **prompt** (string) - Required - Text prompt describing the desired transformation.
- **strength** (number) - Optional - Strength of the transformation (e.g., 0.2).
- **style** (string) - Optional - Curated style name (e.g., "Illustration").

### Request Example
```python
import os

import requests

response = requests.post(
    'https://external.api.recraft.ai/v1/images/imageToImage',
    headers={'Authorization': f"Bearer {os.environ['RECRAFT_API_TOKEN']}"},
    data={
        'prompt': 'winter',
        'strength': 0.2,
        'style': 'Illustration',
    },
    files={
        'image': open('image.png', 'rb'),
    },
)
if not response.ok:
    raise SystemExit(f'{response.status_code}: {response.text}')
print(response.json()['data'][0]['url'])
```

### Response
#### Success Response (200)
- **data[0].url** (string) - URL of the generated image.

#### Response Example
```json
{
  "data": [
    {
      "url": "https://example.com/generated-image.png"
    }
  ]
}
```
```

--------------------------------

### Create style - cURL multipart example

Source: https://www.recraft.ai/docs/api-reference/endpoints

Uploads an image file to create a style reference using multipart/form-data. Requires the RECRAFT_API_TOKEN environment variable.

```bash
curl -X POST https://external.api.recraft.ai/v1/styles \
  -H "Authorization: Bearer $RECRAFT_API_TOKEN" \
  -F "model=recraftv4_styles" \
  -F "file1=@image.png"
```

--------------------------------

### GET /v1/styles/basic

Source: https://www.recraft.ai/docs/api-reference/endpoints

Lists basic styles available. Each basic style includes style_id, style, and the model it works with.

```APIDOC
## GET /v1/styles/basic

### Description
Lists basic styles available. Each basic style includes style_id, style, and the model it works with.

### Method
GET

### Endpoint
https://external.api.recraft.ai/v1/styles/basic

### Authentication
Bearer token (Authorization header)

### Response
#### Success Response (200)
- **styles** (array) - List of basic style objects.
  - **style_id** (string) - Style identifier.
  - **style** (string) - Style name.
  - **model** (string) - Model associated with the style.

#### Response Example
{
  "styles": [
    {
      "style_id": "basic_style_1",
      "style": "any",
      "model": "recraft-v3"
    }
  ]
}
```

--------------------------------

### Create style - cURL JSON example

Source: https://www.recraft.ai/docs/api-reference/endpoints

Creates a style reference by sending image URLs in JSON format. Requires the RECRAFT_API_TOKEN environment variable.

```bash
curl -X POST https://external.api.recraft.ai/v1/styles \
  -H "Authorization: Bearer $RECRAFT_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "recraftv4_styles",
    "image_urls": ["https://example.com/image.png"]
  }'
```

--------------------------------

### Create style and generate image with OpenAI client

Source: https://www.recraft.ai/docs/api-reference/examples

Python example using the OpenAI client with a custom base_url to create a style via the /styles endpoint and then generate an image with the returned style_id. Requires the openai package and the RECRAFT_API_TOKEN environment variable.

```python
# pip install openai
import os

from openai import OpenAI

client = OpenAI(
    base_url='https://external.api.recraft.ai/v1',
    api_key=os.environ['RECRAFT_API_TOKEN'],
)

style = client.post(
    path='/styles',
    cast_to=object,
    body={
        'style': 'digital_illustration',
        'model': 'recraftv3',
        'image_urls': ['https://example.com/image.png'],
    },
)
print(style['id'])

response = client.images.generate(
    prompt='wood potato masher',
    model='recraftv3',
    extra_body={'style_id': style['id']},
)
print(response.data[0].url)
```

--------------------------------

### Python OpenAI SDK example for crisp upscale

Source: https://www.recraft.ai/docs/api-reference/tools/upscale

Uses the OpenAI SDK with a custom base URL to call the crispUpscale endpoint. Prints the resulting image URL.

```python
# pip install openai
import os

from openai import OpenAI

client = OpenAI(
    base_url='https://external.api.recraft.ai/v1',
    api_key=os.environ['RECRAFT_API_TOKEN'],
)

response = client.post(
    path='/images/crispUpscale',
    cast_to=object,
    body={
        'image_url': 'https://cdn.prod.website-files.com/655727fe69827d9a402de12c/679b82f54ef9617939df9d8e_motorcycle--going-fast.png',
    },
)
print(response['image']['url'])
```

--------------------------------

### Generate product photo in 2K with recraftv4_1_utility_pro

Source: https://www.recraft.ai/docs/api-reference/models/recraft-v4-1

Generates a ceramic coffee mug product photo in 2K resolution. Uses the 'recraftv4_1_utility_pro' model and requests a PNG image.

```bash
curl https://external.api.recraft.ai/v1/images/generations \
  -H "Authorization: Bearer $RECRAFT_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "ceramic coffee mug on a white table, soft daylight, product listing photo",
    "model": "recraftv4_1_utility_pro",
    "size": "4:3",
    "image_format": "png"
  }'
```

--------------------------------

### Enhance Prompt Response Example

Source: https://www.recraft.ai/docs/api-reference/tools/enhance-prompt

Example JSON response from the enhance prompt endpoint. The result is a single `enhanced_prompt` string; there is no `data` array because it is not an image.

```json
{
  "enhanced_prompt": "..."
}
```

--------------------------------

### Get user information with cURL

Source: https://www.recraft.ai/docs/api-reference/endpoints

Sends a GET request to the /users/me endpoint to retrieve the current user's information, including credits balance.

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

--------------------------------

### Create and use a custom style with recraftv4_1

Source: https://www.recraft.ai/docs/api-reference/models/recraft-v4-1

Creates a style from an image URL (costs $0.005) and then generates an image using that style. The style works only with the model it was created for, so it is created with 'model': 'recraftv4_1'. Reuse the same STYLE_ID for later requests, or pass 'style_reference_urls' to skip the separate step.

```bash
STYLE_ID=$(curl -s https://external.api.recraft.ai/v1/styles \
  -H "Authorization: Bearer $RECRAFT_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"model": "recraftv4_1", "image_urls": ["https://cdn.prod.website-files.com/655727fe69827d9a402de12c/679b82f54ef9617939df9d8e_motorcycle--going-fast.png"]}' \
  | python3 -c 'import json, sys; print(json.load(sys.stdin)["id"])')

curl https://external.api.recraft.ai/v1/images/generations \
  -H "Authorization: Bearer $RECRAFT_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "a cozy reading corner",
    "model": "recraftv4_1",
    "style_id": "'"$STYLE_ID"'"
  }'
```

--------------------------------

### Upload local reference files with Python

Source: https://www.recraft.ai/docs/api-reference/models/recraft-v4-styles

Python equivalent of the cURL example for uploading local reference files. Uses requests library and reads files in binary mode.

```python
import os

import requests

with open('reference-1.png', 'rb') as ref1, open('reference-2.png', 'rb') as ref2:
    response = requests.post(
        'https://external.api.recraft.ai/v1/images/generations',
        headers={'Authorization': f"Bearer {os.environ['RECRAFT_API_TOKEN']}"},
        data={'prompt': 'product hero shot, bottle on a table', 'model': 'recraftv4_styles'},
        files=[('style_references', ref1), ('style_references', ref2)],
    )
if not response.ok:
    raise SystemExit(f'{response.status_code}: {response.text}')
print(response.json()['data'][0]['url'])
```

--------------------------------

### Recraft API response example

Source: https://www.recraft.ai/docs/api-reference/introduction

Example JSON response from the image generation endpoint, containing the creation timestamp, credits used, and an array with the image ID and URL. The URL is valid for about 24 hours.

```json
{
  "created": 1759140000,
  "credits": 80,
  "data": [{ "image_id": "0e6a1b8c-5b1f-4a8e-9f3a-2c7d4e8b9a10", "url": "https://..." }]
}
```

--------------------------------

### Get SVG result with recraftv3_vector (cURL)

Source: https://www.recraft.ai/docs/api-reference/tools/background

Uses the recraftv3_vector model to get an SVG result instead of a raster image. Costs $0.08 per image. Uses an image URL in the request body.

```bash
curl https://external.api.recraft.ai/v1/images/replaceBackground \
  -H "Authorization: Bearer $RECRAFT_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "image_url": "https://cdn.prod.website-files.com/655727fe69827d9a402de12c/679b82f54ef9617939df9d8e_motorcycle--going-fast.png",
    "prompt": "a desert highway at sunset",
    "model": "recraftv3_vector"
  }'
```

--------------------------------

### Generate image with Python (OpenAI SDK)

Source: https://www.recraft.ai/docs/api-reference/getting-started

Python example using the OpenAI SDK with a custom base URL. Requires the openai package. Prints the URL of the generated image.

```python
# pip install openai
import os

from openai import OpenAI

client = OpenAI(
    base_url='https://external.api.recraft.ai/v1',
    api_key=os.environ['RECRAFT_API_TOKEN'],
)

response = client.images.generate(
    prompt='two race cars on a track',
)
print(response.data[0].url)
```

--------------------------------

### GET /users/me

Source: https://www.recraft.ai/docs/api-reference/endpoints

Retrieves information about the authenticated user.

```APIDOC
## GET /users/me

### Description
Retrieves information about the authenticated user.

### Method
GET

### Endpoint
/users/me

### Authentication
Requires `Authorization: Bearer RECRAFT_API_TOKEN` header.

### Response
#### Success Response (200)
- **id** (string) - The user ID.
- **email** (string) - The user's email.

#### Response Example
{
  "id": "user_123",
  "email": "user@example.com"
}
```

--------------------------------

### Create style and generate image with Python requests

Source: https://www.recraft.ai/docs/api-reference/examples

Python example using the requests library to create a style by uploading a file, then generate an image with the returned style_id. Prints the style_id and the generated image URL. Requires the RECRAFT_API_TOKEN environment variable and the requests package.

```python
import os

import requests

response = requests.post(
    'https://external.api.recraft.ai/v1/styles',
    headers={'Authorization': f"Bearer {os.environ['RECRAFT_API_TOKEN']}"},
    data={
        'style': 'digital_illustration',
        'model': 'recraftv3',
    },
    files={
        'file': open('image.png', 'rb'),
    },
)
if not response.ok:
    raise SystemExit(f'{response.status_code}: {response.text}')
style_id = response.json()['id']
print(style_id)

response = requests.post(
    'https://external.api.recraft.ai/v1/images/generations',
    headers={'Authorization': f"Bearer {os.environ['RECRAFT_API_TOKEN']}"},
    json={
        'prompt': 'wood potato masher',
        'model': 'recraftv3',
        'style_id': style_id,
    },
)
if not response.ok:
    raise SystemExit(f'{response.status_code}: {response.text}')
print(response.json()['data'][0]['url'])
```

--------------------------------

### GET /styles/{style_id}

Source: https://www.recraft.ai/docs/api-reference/endpoints

Retrieves a specific style by its ID.

```APIDOC
## GET /styles/{style_id}

### Description
Retrieves a specific style by its ID.

### Method
GET

### Endpoint
/styles/{style_id}

### Authentication
Requires `Authorization: Bearer RECRAFT_API_TOKEN` header.

### Parameters
#### Path Parameters
- **style_id** (string) - Required - The unique identifier of the style.

### Response
#### Success Response (200)
- **id** (string) - The style ID.
- **name** (string) - The style name.

#### Response Example
{
  "id": "style_123",
  "name": "My Style"
}
```

--------------------------------

### GET /styles

Source: https://www.recraft.ai/docs/api-reference/endpoints

Lists all styles associated with the authenticated user.

```APIDOC
## GET /styles

### Description
Lists all styles associated with the authenticated user.

### Method
GET

### Endpoint
/styles

### Authentication
Requires `Authorization: Bearer RECRAFT_API_TOKEN` header.

### Response
#### Success Response (200)
- **data** (array) - List of style objects.

#### Response Example
{
  "data": [
    {
      "id": "style_123",
      "name": "My Style"
    }
  ]
}
```

--------------------------------

### GET /v1/users/me

Source: https://www.recraft.ai/docs/api-reference/agents

Returns information about the current user, including remaining API credits.

```APIDOC
## GET /v1/users/me

### Description
Returns information about the current user, including remaining API credits.

### Method
GET

### Endpoint
/v1/users/me

### Response
#### Success Response (200)
- **id** (string) - User ID.
- **email** (string) - User email.
- **name** (string) - User name.
- **credits** (number) - Remaining API units balance.

#### Response Example
{
  "id": "...",
  "email": "...",
  "name": "...",
  "credits": 100
}
```

--------------------------------

### GET /v1/styles/{style_id}

Source: https://www.recraft.ai/docs/api-reference/endpoints

Retrieves a single custom style by its ID. Returns the same fields as the list endpoint.

```APIDOC
## GET /v1/styles/{style_id}

### Description
Retrieves a single custom style by its ID. Returns the same fields as the list endpoint.

### Method
GET

### Endpoint
https://external.api.recraft.ai/v1/styles/{style_id}

### Authentication
Bearer token (Authorization header)

### Parameters
#### Path Parameters
- **style_id** (string) - Required - The unique identifier of the style.

### Response
#### Success Response (200)
- **id** (string) - Style identifier.
- **style** (string) - Base style.
- **creation_time** (string) - Creation timestamp.
- **is_private** (boolean) - Whether the style is private.

#### Response Example
{
  "id": "229b2a75-05e4-4580-85f9-b47ee521a00d",
  "style": "any",
  "creation_time": "2023-01-01T00:00:00Z",
  "is_private": false
}
```

--------------------------------

### Python OpenAI SDK example

Source: https://www.recraft.ai/docs/api-reference/tools/remove-background

Uses the OpenAI SDK with a custom base URL to call the removeBackground endpoint. Requires the RECRAFT_API_TOKEN environment variable. Prints the resulting image URL.

```python
# pip install openai
import os

from openai import OpenAI

client = OpenAI(
    base_url='https://external.api.recraft.ai/v1',
    api_key=os.environ['RECRAFT_API_TOKEN'],
)

response = client.post(
    path='/images/removeBackground',
    cast_to=object,
    body={
        'image_url': 'https://cdn.prod.website-files.com/655727fe69827d9a402de12c/679b82f54ef9617939df9d8e_motorcycle--going-fast.png',
    },
)
print(response['image']['url'])
```

--------------------------------

### GET /v1/styles

Source: https://www.recraft.ai/docs/api-reference/endpoints

Lists the custom styles you have created. Each style includes id, style, creation_time, and is_private.

```APIDOC
## GET /v1/styles

### Description
Lists the custom styles you have created. Each style includes id, style, creation_time, and is_private.

### Method
GET

### Endpoint
https://external.api.recraft.ai/v1/styles

### Authentication
Bearer token (Authorization header)

### Response
#### Success Response (200)
- **styles** (array) - List of style objects.
  - **id** (string) - Style identifier.
  - **style** (string) - Base style (e.g., `any`, `vector_illustration`).
  - **creation_time** (string) - Creation timestamp.
  - **is_private** (boolean) - Whether the style is private.

#### Response Example
{
  "styles": [
    {
      "id": "229b2a75-05e4-4580-85f9-b47ee521a00d",
      "style": "any",
      "creation_time": "2023-01-01T00:00:00Z",
      "is_private": false
    }
  ]
}

### Example
```
curl https://external.api.recraft.ai/v1/styles \
  -H "Authorization: Bearer $RECRAFT_API_TOKEN"
```
```

--------------------------------

### JavaScript fetch example for crisp upscale

Source: https://www.recraft.ai/docs/api-reference/tools/upscale

Uses the fetch API in Node.js 18+ as an ES module. Logs the resulting image URL or throws an error on failure.

```javascript
// Node.js 18+, run as an ES module (file.mjs)
const response = await fetch('https://external.api.recraft.ai/v1/images/crispUpscale', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.RECRAFT_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    image_url: 'https://cdn.prod.website-files.com/655727fe69827d9a402de12c/679b82f54ef9617939df9d8e_motorcycle--going-fast.png',
  }),
});
if (!response.ok) throw new Error(await response.text());
const result = await response.json();
console.log(result.image.url);
```

--------------------------------

### POST /v1/images/generations with Controls

Source: https://www.recraft.ai/docs/api-reference/endpoints

Example of generating an image with preferable colors and a background color using the Recraft AI API.

```APIDOC
## POST /v1/images/generations

### Description
Generates an image based on a prompt, with optional controls for colors and background color.

### Method
POST

### Endpoint
https://external.api.recraft.ai/v1/images/generations

### Parameters
#### Request Body
- **prompt** (string) - Required - The text prompt describing the image to generate.
- **controls** (object) - Optional - An object containing generation controls.
  - **colors** (array of color definitions) - Optional - An array of preferable colors. Each color object has:
    - **rgb** (array of 3 integers) - Required - RGB components, each in 0...255 range.
    - **weight** (number or null) - Optional - Relative preference in 0.0...1.0 range. Must be set for all or none, sum must not exceed 1.0.
  - **background_color** (color definition) - Optional - Desired background color, with **rgb** field.
  - **artistic_level** (integer or null) - Optional - Artistic tone, range [0..5]. V3 models only.
  - **no_text** (bool) - Optional - Do not embed text layouts. V3 models only.

### Request Example
{
  "prompt": "race car on a track",
  "controls": {
    "colors": [
      {"rgb": [0, 255, 0], "weight": 0.6},
      {"rgb": [255, 0, 0], "weight": 0.2}
    ],
    "background_color": {"rgb": [40, 40, 40]}
  }
}

### Response
#### Success Response (200)
- **data** (array) - Contains generated image objects.
  - **url** (string) - URL of the generated image.

#### Response Example
{
  "data": [
    {"url": "https://example.com/image.png"}
  ]
}
```

--------------------------------

### Generate image with colors and background_color using Python OpenAI SDK

Source: https://www.recraft.ai/docs/api-reference/endpoints

Uses the OpenAI SDK with a custom base_url to call the images.generate method. Passes the same controls as the requests example via extra_body. Requires the openai package and RECRAFT_API_TOKEN environment variable.

```Python
# pip install openai
import os

from openai import OpenAI

client = OpenAI(
    base_url='https://external.api.recraft.ai/v1',
    api_key=os.environ['RECRAFT_API_TOKEN'],
)

response = client.images.generate(
    prompt='race car on a track',
    extra_body={
        'controls': {
            'colors': [
                {'rgb': [0, 255, 0], 'weight': 0.6},
                {'rgb': [255, 0, 0], 'weight': 0.2},
            ],
            'background_color': {'rgb': [40, 40, 40]},
        },
    },
)
print(response.data[0].url)
```
Tokens:
Raw