Skip to main content
POST
/
images
/
{id}
/
edit
Edit an image
curl --request POST \
  --url https://www.trybloom.ai/api/v1/images/{id}/edit \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "prompt": "<string>",
  "brandSessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "imageSize": "2K",
  "referenceImageIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "<unknown>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://www.trybloom.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string<uuid>
required

ID of a completed or uploaded image to edit

Body

application/json
​
prompt
string
required

What to change — describe the edit (e.g. "make the background blue"). Aspect ratio is locked to the original image's ratio.

Required string length: 1 - 2000
​
brandSessionId
string<uuid>
required

Brand session ID (from GET /brands)

​
imageSize
enum<string>
default:2K

"2K" (default, 1 credit) or "4K" (2 credits, Plus/Pro)

Available options:
2K,
4K
​
model
enum<string>

Model tier. "fast" (cheaper/faster), "standard" (mid tier), or "pro" (default, highest quality).

Available options:
fast,
standard,
pro
​
referenceImageIds
string<uuid>[]

IDs of uploaded or generated images for additional context (max 9)

Maximum array length: 9

Response

OK

​
data
object
required