API Reference
  1. PhotoEditAPI
  2. Generate

Generate an image

post
https://api.photoeditapi.com/v1/generate/image

Generate a new AI image using a preset and model from a preset collection. Inputs are transformed by the selected preset — for example, the ecommerce preset places your product in a professional studio setting.

Idempotency: Duplicate requests with identical inputs for the same end-user return the existing generation instead of creating a new one.

Asynchronous: The response returns immediately with status: pending. Poll GET /outputs/{generation_uuid} until status changes to completed or failed. Generation typically completes within 10–30 seconds.

Credit cost depends on the model selected — use GET /presets/{collectionId} to see current pricing before submitting.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The preset collection to use. Fetch available collections and their models/presets from GET /presets/{collectionId}.

string
enum
required

The preset to apply from the collection. Each preset defines a different transformation style (e.g. ecommerce, stage, model). Fetch the full list from GET /presets/{collectionId}.

Allowed:
string
required

The AI model to use. Fetch the available model IDs, their credit cost, and supported aspect ratios from GET /presets/{collectionId}.

string
enum
required

Target aspect ratio for the output image.

Allowed:
input_images
array of strings
required
length ≥ 1

One or more source images to transform. Each item must be either a public HTTPS URL or a key returned by POST /upload/get-signed-image-upload-url after the file has been uploaded.

input_images*

Public HTTPS URL or an upload key in the format {tenant_id}/user_uploads/...

string | null

Optional text prompt to guide the generation. Required for preset_id: custom; enhances results for other presets. Maximum 2200 characters.

Headers
string
required
^[a-zA-Z0-9_\-~]+$

A stable, unique identifier for the end-user making the request. Accepts alphanumeric characters, dashes (-), underscores (_), and tildes (~). This maps the request to the correct credit balance and output history.

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?