Getting started with YandexART

To run examples of requests using the API, install:

• cURL to send API requests
• jq utility to work with JSON files

To work with the YandexART API, you need to get authenticated using your account:

1. Get an IAM token for your Yandex account or federated account.

2. Get the ID of the folder for which your account has the ai.imageGeneration.user role or higher. You will need the folder ID to get the model URI.

3. When accessing YandexART via the API, specify the IAM token in the Authorization header of each request:

   x-folder-id: <folder_ID>
   

For information about other API authentication methods, see Authentication with the Yandex Foundation Models API.

1. Create a file with the request body, e.g., prompt.json:

   {
   "modelUri": "art://<folder_ID>/yandex-art/latest",
   "generationOptions": {
     "seed": "1863",
     "aspectRatio": {
        "widthRatio": "2",
        "heightRatio": "1"
      }
   },
   "messages": [
     {
       "weight": "1",
       "text": "a pattern of pastel colored succulents of multiple varieties, hd full wallpaper, sharp focus, many intricate details, picture depth, top view"
     }
   ]
   }
   

   Where:

   • modelUri: YandexART model ID which contains a Yandex Cloud folder ID.
   • seed: Generation seed.
   • text: Text description of the image to use for generation.
   • weight: Text description weight. If a request contains more than one description, their individual impact will be calculated based on weight, with the sum of all weights equal to 1.
   • aspectRatio: (Optional) Aspect ratio of the generated image:
     • widthRatio: Width (default value: 1).
     • heightRatio: Height (default value: 1).

2. To send a request to the neural network using the ImageGenerationAsync.generate method, run the following command:

   curl \
     --request POST \
     --header "Authorization: Bearer <IAM_token_value>" \
     --data "@prompt.json" \
     "https://llm.api.cloud.yandex.net/foundationModels/v1/imageGenerationAsync"
   

   Where:

   • <IAM_token_value>: IAM token you got for your account.
   • prompt.json: JSON file with request parameters.

   The service will return the ID of your request in response:

   {
   "id":"fbveu1sntj**********","description":"","createdAt":null,"createdBy":"","modifiedAt":null,"done":false,"metadata":null}
   

3. Generating an image takes some time. Wait for 10 seconds and send your request to get the generation result. When the image is ready, you will get the result in a Base64-encoded file named image.jpeg.

   curl \
     --request GET \
     --header "Authorization: Bearer <IAM_token_value>" \
     https://llm.api.cloud.yandex.net:443/operations/<request_ID> | \
     jq -r '.response | .image' | base64 -d > image.jpeg
   

   Where:

   • <IAM_token_value>: IAM token you obtained when getting started.
   • <request_ID>: id field value obtained in response to the generation request.

   Result: