Skip to main content
POST
/
v1
/
images
/
generations
PHOTA Image Edit
curl --request POST \
  --url https://api.foxapi.cc/v1/images/generations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "phota-image-edit",
  "prompt": "Change the background to a tropical beach at sunset",
  "image_urls": [
    "https://example.com/portrait.jpg"
  ],
  "num_outputs": 1,
  "resolution": "1K"
}
'
{
  "created": 1757165031,
  "id": "task-unified-1757165031-uyujaw3d",
  "model": "<string>",
  "object": "image.generation.task",
  "progress": 0,
  "status": "pending",
  "task_info": {
    "can_cancel": true,
    "estimated_time": 45
  },
  "type": "image"
}

Documentation Index

Fetch the complete documentation index at: https://docs.foxapi.cc/llms.txt

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

Authorizations

​
Authorization
string
header
required

All APIs require Bearer Token authentication

Add to request header:

Authorization: Bearer YOUR_API_KEY

Body

application/json
​
model
string
default:phota-image-edit
required

phota-image-edit: Image editing, supports profile

Example:

"phota-image-edit"

​
prompt
string
required

Editing prompt

Notes:

  • Describe the editing requirements for the input image
Example:

"Change the background to a tropical beach at sunset"

​
image_urls
string[]
required

Input image URL list

Notes:

  • Images to edit
  • Must be publicly accessible URLs
Example:
["https://example.com/portrait.jpg"]
​
num_outputs
integer
default:1

Number of output images

Notes:

  • Each image is billed independently
Example:

1

​
resolution
string
default:1K

Output image resolution

Options:

  • 1K — Standard resolution
  • 4K — High resolution (double price)
Example:

"1K"

​
profile_ids
string[] | null

Profile ID list

Notes:

  • Profile IDs created by phota-create-profile
  • Used to maintain character consistency in editing results

Do not pass this parameter unless necessary.

Example:
["profile_abc123"]

Response

Task created successfully

​
created
integer

Task creation timestamp

Example:

1757165031

​
id
string

Task ID

Example:

"task-unified-1757165031-uyujaw3d"

​
model
string

Actual model name used

​
object
enum<string>

Specific task type

Available options:
image.generation.task
​
progress
integer

Task progress percentage (0-100)

Required range: 0 <= x <= 100
Example:

0

​
status
enum<string>

Task status

Available options:
pending,
processing,
completed,
failed
Example:

"pending"

​
task_info
object

Async task information

​
type
enum<string>

Task output type

Available options:
image
Example:

"image"