Images API

The image API allows you to generate one or more images from a natural language prompt. Depending on the selected provider and model, you can adjust parameters such as size, quality and aspect ratio.

Check the Globant Enterprise AI API Reference for generic variables needed to use the API.

Endpoint

POST /images/generations

Generates images from a text description using the selected model and rendering settings.

Request

• Method: POST
• Path: $BASE_URL/images/generations
• Headers:
  • Content-Type: application/json
  • Authorization: Bearer $GEAI_APITOKEN

Request Body

{
  "model": "string",         // e.g. "openai/gpt-image-1"
  "prompt": "string",        // Description of the desired image
  "n": integer,              // Number of images to generate (1-10 depending on model)
  "quality": "string",       // Rendering quality, e.g. "high"
  "size": "string",          // Image dimensions, e.g. "1024x1024"
  "aspectRatio": "string"   // Relationship between an image's width and height (1:1, 9:16, 16:9, 3:4, 4:3). Optional.
}

The supported models and their accepted parameters are listed in the following table.

cURL Sample

curl -X POST "$BASE_URL/images/generations" \
-H "Authorization: Bearer $GEAI_APITOKEN" \
-H 'Content-Type: application/json' \
-d '{
  "model": "openai/gpt-image-1",
  "prompt": "generate a lovely bath basket with attractive items in it",
  "n": 1,
  "quality": "high",
  "size": "1024x1024"
}'

POST /images/edits

Edits a single image using an AI model, based on a user-provided prompt and (optionally) a mask image. Returns edited images as Amazon Simple Storage Service (S3) URLs.

Parameters

The supported models and their accepted parameters are listed in the following table.

NOTE: Although these models will remain available, new models are periodically added for these purposes. You can check the complete list of available models in the Console.

Request

• Method: POST
• Path: $BASE_URL/images/edits

Request Body

{
  "model": "string",      // e.g., "openai/gpt-image-1", "openai/gpt-image-1-mini"
  "prompt": "string",     // e.g., "remove background people"
  "image": "string",      // URL format e.g., "https://example.com/image.jpg"
  "size": "string",       // Image size in pixels e.g., "1024x1024"
  "n": integer            // Number of images to generate (1-10)
}

Response

{
  "created": integer,        // Unix timestamp
  "data": 
    {
      "url": "string",          // URL to the edited image
      "revised_prompt": "string", // (optional) revised prompt
      "b64_json": "string"      // (optional) base64-encoded image data
    }
// Repeats this node for each edited image
  ,
  "usage": {
    "total_tokens": integer,
    "total_cost": integer,
    "currency": "string",       // e.g., "USD"
    "prompt_tokens_details": "string",     // object or null
    "completion_tokens_details": "string" // object or null
  }
}

cURL Sample

curl -X POST "$BASE_URL/images/edits" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "openai/gpt-image-1",
    "prompt": "remove the ball",
    "image": "https://www.reuters.com/resizer/v2/X4XAFRTDTNLN7FCKZQY663TLUQ.jpg?auth=b33090e2931bc7bd4f74df13155afd9fdba9a6a41bea66da0726b9cdf4f24da0&width=960&quality=80",
    "size": "1024x1024",
    "n": 1
  }'

See Also

• OpenAI
• Google Vertex AI
• xAI