API reference - Phota API Documentation

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.

Endpoint	Method	Description
`/v1/phota/edit`	POST	Edit images using a text prompt and optional profile references
`/v1/phota/generate`	POST	Generate new images from a text prompt (no input image)
`/v1/phota/enhance`	POST	Automatically enhance a photo without a text prompt
`/v1/phota/remix`	POST	Restyle an image to match a reference image
`/v1/phota/jobs/{job_id}`	GET	Poll the status and result of an asynchronous job
`/v1/phota/webhook-secret`	GET	Fetch your per-account secret for verifying callback signatures

Profiles

Endpoint	Method	Description
`/v1/phota/profiles/add`	POST	Create a new profile and start asynchronous training
`/v1/phota/profiles/ids`	GET	List all profiles for the authenticated account
`/v1/phota/profiles/{profile_id}/status`	GET	Check the training status of a profile
`/v1/phota/profiles/{profile_id}/profile_picture`	GET	Retrieve the profile picture as a JPEG image
`/v1/phota/profiles/{profile_id}`	DELETE	Permanently 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

​Authentication

​Endpoints overview

​Studio

​Profiles

​Guides

Authentication

Endpoints overview

Studio

Profiles

Guides