Skip to main content
POST
/
v1
/
phota
/
edit
Edit
curl --request POST \
  --url https://api.photalabs.com/v1/phota/edit \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "prompt": "",
  "images": [
    "<string>"
  ],
  "profile_ids": [
    "<string>"
  ],
  "num_output_images": 1,
  "aspect_ratio": "auto",
  "resolution": "1K"
}
'
{
  "images": [
    "<string>"
  ],
  "known_subjects": {
    "counts": {}
  }
}

Authorizations

​
X-API-Key
string
header
required

Body

application/json

Request body for the edit endpoint.

Input images can be provided as either raw base64-encoded bytes or publicly accessible URLs (e.g. https://example.com/photo.jpg). Both formats are accepted and detected automatically.

​
prompt
string
default:""

Text prompt describing the desired edit.

​
images
string[]

Input images as raw base64 strings or publicly accessible URLs. Both formats are auto-detected.

Maximum array length: 10
​
profile_ids
string[]

Subset of your account's profiles relevant to this request. Your account holds all profiles, but only pass the ones belonging to the end-user whose photo is being edited. These profiles serve as candidates for identity preservation. The fewer profiles you pass, the easier it is for our system to determine which profiles are relevant.

​
num_output_images
integer
default:1

Number of output images to generate (1-4).

Required range: 1 <= x <= 4
​
aspect_ratio
enum<string>
default:auto

Output aspect ratio (auto, 1:1, 3:4, 4:3, 9:16, 16:9).

Available options:
auto,
1:1,
3:4,
4:3,
9:16,
16:9
​
resolution
enum<string>
default:1K

Output resolution (1K, 4K).

Available options:
1K,
4K

Response

Successful Response

Response returned by the edit and generate endpoints.

​
images
string[]
required

Base64-encoded PNG output image(s).

​
known_subjects
KnownGeneratedSubjectCounts · object
required

Dictionary mapping a known subject's profile_id to the number of times they were generated. If multiple variations are generated, this will be the aggregated count across all variations.