images

Edit a base image with optional references and regions

Create an asynchronous edit task where images[0] is the base image and later images are ordered references. Optional normalized regions target inputs by index. auto selects a compatible live model; a concrete model is never substituted.

post/v1/images/edits

Request

  • Base URL: https://api.beatra.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.beatra.ai/v1/images/edits
  • Auth: none declared. Required headers: Idempotency-Key

Headers

x-request-idstring nullable
Idempotency-Keystring required
authorizationstring nullable

Request body

metadataobject nullable

Caller-supplied metadata; ≤16 keys, key ≤64 chars, value ≤512 chars

callback_urlstring nullable

HTTPS URL beatra will POST the final Task envelope to when the Task reaches a terminal state

callback_signing_key_idstring nullable

Optional standalone callback signing key. Omit for unsigned callback delivery; requires callback_url when provided.

model'auto' | 'gpt-image-2.5-flare' | 'gpt-image-2.5-sunburst' | 'gpt-image-2' | 'image-01-live' | 'wan2.7-image-pro' | 'wan2.7-image' | 'qwen-image-3.0-pro' | 'qwen-image-3.0' | 'qwen-image-2.0-pro' | 'qwen-image-2.0'

Use auto for compatibility-based selection from the configured live candidates. A concrete model is evaluated exactly as requested and is never substituted.

promptstring required

Required prompt containing at least one non-whitespace character.

countinteger

Requested output image count. The public range is one through four, and the selected model must support the exact count; Beatra does not split the request.

seedinteger nullable

Optional random seed. Supplying it constrains model eligibility; omit it for model-managed randomness.

negative_promptstring nullable

Optional content or qualities to avoid. Supplying it constrains model eligibility and is rejected when no compatible model is available.

enhance_promptboolean nullable

Ask the model to rewrite the prompt before generation. Omit or use null to keep the prompt exactly as written; an explicit boolean constrains model eligibility.

Response

Task accepted

object'task'
task_idstring required
status'queued' | 'running' | 'succeeded' | 'failed' | 'canceled' required
capabilitystring required
workload_type'model' | 'social_operation'
modelstring nullable

Caller-requested model verbatim (may be 'auto'). Null for social_operation tasks.

resolved_modelstring nullable

Actual model that ran (null until execution starts; equals model for explicit-model calls)

model_selection_reasonunknown
metadataobject nullable
inputobject nullable
outputobject nullable
created_atstring date-time required
started_atstring date-time nullable
deadline_atstring date-time nullable
completed_atstring date-time nullable
cancel_requested_atstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.