Skip to main content
POST
Edit an image

Authorizations

Authorization
string
header
required

User-bound credential carrying an identity: either a session JWT or a user access token (at:*) generated from the user settings UI. Send as Authorization: Bearer <token>. Org API keys (iak_*) are not accepted here - they carry no user identity. Use the x-prismeai-api-key header instead (see OrgApiKeyAuth).

Body

application/json
model
string

Image model id. Defaults to the org governance default, then the platform default.

Maximum string length: 256
prompt
string

Instruction describing the edit.

image_url
string

URL of the source image, fetched by the gateway.

size
string

Explicit WxH pixel size (same resolution rules as generation).

aspect
enum<string>

Prisme.ai extension. Abstract orientation.

Available options:
square,
portrait,
landscape
tier
enum<string>

Prisme.ai extension. Size tier (default medium).

Available options:
small,
medium,
large
n
number

Number of images to return (default 1).

analytics_context
object

Prisme.ai extension. Caller-supplied analytics context.

Response

Edited images.

created
integer

Unix timestamp of the generation.

model
string

Model that produced the images (after governance resolution).

data
object[]
size
string

Prisme.ai extension. Size actually used after resolution.