---
updatedAt: 2026-03-06T21:46:41.000Z
agentTools:
  projectIndex: https://developers.hrflow.ai/llms.txt
---

# 🧠 Generate a job scene illustration

This endpoint allows you to generate an image that illustrates a job description.

> 📘 Prerequisites
>
> 1. [✨ Create a Workspace](https://hrflow.ai/signup)
> 2. [🔑 Get your API Key](https://developers.hrflow.ai/docs/api-authentification)
> 3. [🧠 Activate Text Imaging API](docs:ai-solutions#imaging-api)

> 🚧 Image Size
>
> * The width and height of the image should be among the following pixel values : \[256, 512]
> * The default value is 256px for each.

## Request headers

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        Field
      </th>

      <th>
        Value
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        <code>Content-Type</code>
      </td>

      <td>
        <code>application/json</code>
      </td>
    </tr>

    <tr>
      <td>
        <code>X-API-KEY</code>
      </td>

      <td>
        Your API Key.
      </td>
    </tr>

    <tr>
      <td>
        <code>X-USER-EMAIL</code>
      </td>

      <td>
        Your HrFlow\.ai account's email.
      </td>
    </tr>
  </tbody>
</Table>

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "website-api",
    "version": "2.3"
  },
  "servers": [
    {
      "url": "https://api.hrflow.ai/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-KEY",
        "x-default": ""
      },
      "sec1": {
        "type": "apiKey",
        "in": "header",
        "name": "X-USER-EMAIL"
      }
    }
  },
  "security": [
    {
      "sec0": [],
      "sec1": []
    }
  ],
  "paths": {
    "/text/imaging": {
      "post": {
        "summary": "🧠 Generate a job scene illustration",
        "description": "This endpoint allows you to generate an image that illustrates a job description.",
        "operationId": "text-imaging",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "text"
                ],
                "properties": {
                  "text": {
                    "type": "string",
                    "description": "Job text that describes the image to be generated. Ideally it should includes a \"Job title\".",
                    "default": "Data scientist"
                  },
                  "width": {
                    "type": "string",
                    "description": "Width of the image",
                    "default": "256",
                    "enum": [
                      "256",
                      "512"
                    ]
                  }
                }
              },
              "examples": {
                "Request Example": {
                  "value": {
                    "prompt_face": null
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"code\": 200,\n    \"message\": \"Image generation ended successfully.\",\n    \"data\": {\n        \"image_url\": \"https://riminder-documents-eu-2019-12.s3.eu-west-1.amazonaws.com/teams/02625df2619d59e60911da547c81dabe2a850f1a/imaging/gy9ecosx2pp5reaz0yiaxxjtuxvdnhgrzonebe7m.png\"\n    }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "integer",
                      "example": 200,
                      "default": 0
                    },
                    "message": {
                      "type": "string",
                      "example": "Image generation ended successfully."
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "image_url": {
                          "type": "string",
                          "example": "https://riminder-documents-eu-2019-12.s3.eu-west-1.amazonaws.com/teams/02625df2619d59e60911da547c81dabe2a850f1a/imaging/gy9ecosx2pp5reaz0yiaxxjtuxvdnhgrzonebe7m.png"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"code\": 400,\n  \"message\": \"Bad request. Text cannot be null.\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "integer",
                      "example": 400,
                      "default": 0
                    },
                    "message": {
                      "type": "string",
                      "example": "Bad request. Text cannot be null."
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```