Contact UsGet started

Foundation Models Image Generation API, REST: ImageGenerationAsync.Generate

Written by
Updated at November 26, 2024

A method for generating an image based on a textual description.

HTTP request

POST https://llm.api.cloud.yandex.net/foundationModels/v1/imageGenerationAsync

Body parameters

{
  "modelUri": "string",
  "messages": [
    {
      "text": "string",
      "weight": "string"
    }
  ],
  "generationOptions": {
    "mimeType": "string",
    "seed": "string",
    "aspectRatio": {
      "widthRatio": "string",
      "heightRatio": "string"
    }
  }
}

Request for the service to generate an image.

For examples of usage, see step-by-step guide.

Field

Description

modelUri

string

The model URI to be used for image generation.

messages[]

Message

A list of messages representing the context for the image generation model.

generationOptions

ImageGenerationOptions

Image generation options.

Message

The text descriptions and weights that the model uses to generate an image.

Field

Description

text

string

Text describing the image.

weight

string

Message weight. Negative values indicate negative messages.

ImageGenerationOptions

Field

Description

mimeType

string

The MIME type of generated image format.
For possible specifications, see documentation.

seed

string (int64)

Seed for image generation. It serves as a starting point for image generation from noise.

aspectRatio

AspectRatio

Aspect ratio of generated image.

AspectRatio

Field

Description

widthRatio

string (int64)

Weight of width in image.

heightRatio

string (int64)

Weight of height in image.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": "object",
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "image": "string",
    "modelVersion": "string"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

object

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

ImageGenerationResponse

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

Status

The error result of the operation in case of failure or cancellation.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

ImageGenerationResponse

Response containing generated image.

Field

Description

image

string (bytes)

The image is serialized as an array of bytes encoded in Base64.

modelVersion

string

The model version changes with each new releases.
Previous
Overview
Next
Overview