Skip to main content
POST
Start a non-destructive image edit

Authorizations

Authorization
string
header
required

Mint API key sent as a Bearer token.

Headers

Idempotency-Key
string

Optional stable key for safely retrying an uncertain mutating request. Mint creates an internal key when this header is omitted. Reusing a supplied key with different parameters returns 409.

Required string length: 1 - 255

Path Parameters

imageId
string
required

Body

application/json

Instructions for creating a non-destructive Image edit.

editInstruction
string
required

Describe the change Mint should apply to the source Image.

Required string length: 1 - 8000
name
string

Optional title for the new edited Image.

Required string length: 1 - 120
generationPreset
enum<string>
default:standard

Quality, speed, and cost tier for the Image edit.

Available options:
fast,
standard,
production

Response

An earlier request with the same retry key returned this operation.

A long-running operation acting on one Mint image.

object
string
required

Stable object discriminator.

Allowed value: "operation"
id
string
required

Mint operation ID used for polling.

type
enum<string>
required

The work this operation performs.

Available options:
image_edit
generationMode
enum<string>
required

Workflow mode for this operation.

Available options:
auto,
review
status
enum<string>
required

Current operation lifecycle status.

Available options:
queued,
running,
preview_ready,
billing_required,
succeeded,
partially_succeeded,
failed,
canceled
resource
object
required

The Mint image affected by this operation.

createdAt
string<date-time>
required

When the operation was created.

updatedAt
string<date-time>
required

When the operation last changed.

billing
object

The billing action required before this operation can continue.

credits
object

Credit estimate, active reservation, finalized charge, and post-reservation balance for this operation.

error
object

Terminal failure details when the operation failed.

completedAt
string<date-time>

When the operation completed.

canceledAt
string<date-time>

When the operation was canceled.