Skip to main content
The API reference is auto-generated from the Phota API’s OpenAPI specification. Use the sidebar to browse individual endpoints, view request and response schemas, and try requests directly from the docs.

​
Authentication

All endpoints require an API key passed in the X-API-Key header: 
curl https://api.photalabs.com/v1/phota/profiles/ids \
  -H "X-API-Key: YOUR_API_KEY"
See the Authentication guide for details on obtaining and managing keys.

​
Endpoints overview

​
Studio

The image endpoints also support an asynchronous mode for long-running requests — submit with async: true, then poll the job endpoint below.
EndpointMethodDescription
/v1/phota/editPOSTEdit images using a text prompt and optional profile references
/v1/phota/generatePOSTGenerate new images from a text prompt (no input image)
/v1/phota/enhancePOSTAutomatically enhance a photo without a text prompt
/v1/phota/remixPOSTRestyle an image to match a reference image
/v1/phota/jobs/{job_id}GETPoll the status and result of an asynchronous job
/v1/phota/webhook-secretGETFetch your per-account secret for verifying callback signatures

​
Profiles

EndpointMethodDescription
/v1/phota/profiles/addPOSTCreate a new profile and start asynchronous training
/v1/phota/profiles/idsGETList all profiles for the authenticated account
/v1/phota/profiles/{profile_id}/statusGETCheck the training status of a profile
/v1/phota/profiles/{profile_id}/profile_pictureGETRetrieve the profile picture as a JPEG image
/v1/phota/profiles/{profile_id}DELETEPermanently delete a profile and all associated data

​
Guides

For a guided walkthrough, start with the Quickstart. For conceptual background, see:
  • Profiles guide — identity preservation, lifecycle, and prompt syntax
  • Use cases — visual examples of edit, generate, enhance, and remix
  • Remix guide — restyle a photo to match a reference image