ImageGeneration

Generate an image with LLMs

Generate images with LLMs using a natural language prompt.

yaml
type: "io.kestra.plugin.ai.completion.ImageGeneration"

Examples

Generate an image using OpenAI (DALL-E 3)

yaml
id: image_generation
namespace: company.ai

tasks:
  - id: image_generation
    type: io.kestra.plugin.ai.completion.ImageGeneration
    prompt: >
      Four-panel comic page about a data engineer shipping a workflow.
      Clean modern line art with soft colors and ample white space.
      Panel 1: Early morning desk setup with dual monitors, coffee, and a workflow DAG on screen; calm focused mood.
      Panel 2: Debugging a failing task; close-up of terminal and error icon; speech bubble: "hmm…"
      Panel 3: Fix applied; green checks ripple through the pipeline; small celebratory detail (cat paw, fist pump).
      Panel 4: Deployed dashboard showing metrics trending up; sticky note says "ship it".
      Include subtle tech props (cloud icons, database cylinder) but no logos.
      Minimal readable text only in tiny bubbles/notes; no large paragraphs of text.
    provider:
      type: io.kestra.plugin.ai.provider.OpenAI
      apiKey: "{{ kv('OPENAI_API_KEY') }}"
      modelName: dall-e-3

Properties

prompt *string

Image prompt

The input prompt for the image generation model

provider *AmazonBedrock Anthropic AzureOpenAI DashScope DeepSeek GoogleGemini GoogleVertexAI HuggingFace LocalAI MistralAI OciGenAI Ollama OpenAI OpenRouter WorkersAI ZhiPuAI

Language Model Provider

Outputs

finishReason string

Possible Values

STOPLENGTHTOOL_EXECUTIONCONTENT_FILTEROTHER

Finish reason

imageUrl string

Generated image URL

The URL of the generated image

tokenUsage TokenUsage

Token usage

Metrics

input.token.count counter

Unit token

Large Language Model (LLM) input token count

output.token.count counter

Unit token

Large Language Model (LLM) output token count

total.token.count counter

Unit token

Large Language Model (LLM) total token count

Definitions

Azure OpenAI Model Provider

endpoint *string

API endpoint

The Azure OpenAI endpoint in the format: https://{resource}.openai.azure.com/

modelName *string

Model name

type *object

apiKey string

API Key

baseUrl string

Base URL

Custom base URL to override the default endpoint (useful for local tests, WireMock, or enterprise gateways).

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientId string

Client ID

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

clientSecret string

Client secret

serviceVersion string

API version

tenantId string

Tenant ID

Google VertexAI Model Provider

endpoint *string

Endpoint URL

location *string

Project location

modelName *string

Model name

project *string

Project ID

type *object

baseUrl string

Base URL

Custom base URL to override the default endpoint (useful for local tests, WireMock, or enterprise gateways).

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

Google Gemini Model Provider

apiKey *string

API Key

modelName *string

Model name

type *object

baseUrl string

Base URL

Custom base URL to override the default endpoint (useful for local tests, WireMock, or enterprise gateways).

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

Mistral AI Model Provider

apiKey *string

API Key

modelName *string

Model name

type *object

baseUrl string

Base URL

Custom base URL to override the default endpoint (useful for local tests, WireMock, or enterprise gateways).

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

ZhiPu AI Model Provider

apiKey *string

API Key

modelName *string

Model name

type *object

baseUrl string

Default https://open.bigmodel.cn/

API base URL

The base URL for ZhiPu API (defaults to https://open.bigmodel.cn/)

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

maxRetries integerstring

The maximum retry times to request

maxToken integerstring

The maximum number of tokens returned by this request

stops array

SubType string

With the stop parameter, the model will automatically stop generating text when it is about to contain the specified string or token_id

OciGenAI Model Provider

compartmentId *string

OCID of OCI Compartment with the model

modelName *string

Model name

region *string

OCI Region to connect the client to

type *object

authProvider string

OCI SDK Authentication provider

baseUrl string

Base URL

Custom base URL to override the default endpoint (useful for local tests, WireMock, or enterprise gateways).

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

Deepseek Model Provider

apiKey *string

API Key

modelName *string

Model name

type *object

baseUrl string

Default https://api.deepseek.com/v1

API base URL

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

Anthropic AI Model Provider

apiKey *string

API Key

modelName *string

Model name

type *object

baseUrl string

Base URL

Custom base URL to override the default endpoint (useful for local tests, WireMock, or enterprise gateways).

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

maxTokens integerstring

Maximum Tokens

Specifies the maximum number of tokens that the model is allowed to generate in its response.

OpenRouter Model Provider

apiKey *string

API Key

modelName *string

Model name

type *object

baseUrl string

Base URL

Custom base URL to override the default endpoint (useful for local tests, WireMock, or enterprise gateways).

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

Ollama Model Provider

endpoint *string

Model endpoint

modelName *string

Model name

type *object

baseUrl string

Base URL

Custom base URL to override the default endpoint (useful for local tests, WireMock, or enterprise gateways).

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

OpenAI Model Provider

apiKey *string

API Key

modelName *string

Model name

type *object

baseUrl string

Default https://api.openai.com/v1

API base URL

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

DashScope (Qwen) Model Provider from Alibaba Cloud

apiKey *string

API Key

modelName *string

Model name

type *object

baseUrl string

Default https://dashscope-intl.aliyuncs.com/api/v1

API base URL

text

If you use a model in the China (Beijing) region, you need to replace the URL with: https://dashscope.aliyuncs.com/api/v1,
otherwise use the Singapore region of: "https://dashscope-intl.aliyuncs.com/api/v1.
The default value is computed based on the system timezone.

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

enableSearch booleanstring

Whether the model uses Internet search results for reference when generating text or not

maxTokens integerstring

The maximum number of tokens returned by this request

repetitionPenalty numberstring

Repetition in a continuous sequence during model generation

text

Increasing repetition_penalty reduces the repetition in model generation,
1.0 means no penalty. Value range: (0, +inf)

io.kestra.plugin.ai.domain.TokenUsage

inputTokenCount integer

outputTokenCount integer

totalTokenCount integer

LocalAI Model Provider

baseUrl *string

API base URL

modelName *string

Model name

type *object

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

Amazon Bedrock Model Provider

accessKeyId *string

AWS Access Key ID

modelName *string

Model name

secretAccessKey *string

AWS Secret Access Key

type *object

baseUrl string

Base URL

Custom base URL to override the default endpoint (useful for local tests, WireMock, or enterprise gateways).

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

modelType string

Default COHERE

Possible Values

COHERETITAN

Amazon Bedrock Embedding Model Type

HuggingFace Model Provider

apiKey *string

API Key

modelName *string

Model name

type *object

baseUrl string

Default https://router.huggingface.co/v1

API base URL

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

WorkersAI Model Provider

accountId *string

Account Identifier

Unique identifier assigned to an account

apiKey *string

API Key

modelName *string

Model name

type *object

baseUrl string

Base URL

Custom base URL to override the default endpoint (useful for local tests, WireMock, or enterprise gateways).

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

​Image​Generation

ImageGeneration