Skip to main content
POST
/
v1
/
images
/
generations
PATINA Material Extract
curl --request POST \
  --url https://api.foxapi.cc/v1/images/generations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "patina-material-extract",
  "image_url": "https://example.com/wall-photo.jpg",
  "image_size": 1024,
  "maps": [
    "basecolor",
    "normal",
    "roughness"
  ]
}
'
{
  "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:patina-material-extract
required

patina-material-extract: Extracts textures from images and generates PBR maps

Example:

"patina-material-extract"

​
image_url
string
required

Input image public URL

Notes:

  • Source image for material extraction
  • Must be a publicly accessible URL
Example:

"https://example.com/wall-photo.jpg"

​
maps
string[]
required

PBR map types to generate

Options:

  • basecolor — Base color map
  • normal — Normal map
  • roughness — Roughness map
  • metalness — Metalness map
  • height — Height map
Example:
["basecolor", "normal", "roughness"]
​
mask_url
string | null

Mask image public URL

Notes:

  • Specifies which area of the image to extract material from
Example:

"https://example.com/mask.png"

​
image_size
integer
default:1024

Output image size (pixels)

Notes:

  • Controls the size of extracted textures and PBR maps
Example:

512

​
upscale_factor
integer | null

Upscale factor

Notes:

  • Upscales the output material
  • Enabling increases billing

Do not pass this parameter unless necessary.

Example:

2

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"