Skip to main content
POST
/
v1
/
phota
/
profiles
/
add
Add Profile
curl --request POST \
  --url https://api.photalabs.com/v1/phota/profiles/add \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "image_urls": [
    "<string>"
  ],
  "tag": "<string>"
}
'
{
  "profile_id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.photalabs.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Body

application/json

Request body for creating a new profile.

​
image_urls
string[]
required

Publicly accessible URLs pointing to the training images. Supported formats: JPEG, PNG, WebP, and HEIC/HEIF. Images larger than 4K (4096px) are automatically resized; for best results, provide images at 4K or below. PNG images are transcoded to JPEG (quality 95) for storage efficiency.

Required array length: 30 - 50 elements
​
tag
string | null

Optional immutable tag to group or namespace this profile (e.g., your end-user's identifier).

Required string length: 1 - 128

Response

Successful Response

Response returned after a profile is created.

​
profile_id
string
required

Unique identifier for the new profile. Use this to poll training status.