POST
/
v1
/
custom-references
Create character
curl --request POST \
  --url https://platform.higgsfield.ai/v1/custom-references \
  --header 'Content-Type: application/json' \
  --header 'hf-api-key: <hf-api-key>' \
  --header 'hf-secret: <hf-secret>' \
  --data '{
  "name": "<string>",
  "input_images": [
    {
      "type": "<string>",
      "image_url": "<string>"
    }
  ]
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "status": "not_ready",
  "thumbnail_url": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "in_progress_at": "2023-11-07T05:31:56Z"
}

Headers

​
hf-api-key
string<uuid>
required
​
hf-secret
string
required

Body

application/json
​
name
string
required
Maximum length: 100
​
input_images
ImageUrlInputImageSchema · object[]
required
Required array length: 1 - 100 elements

Response

Successful Response

​
id
string<uuid>
required
​
name
string
required
Maximum length: 100
​
created_at
string<date-time>
required
​
status
enum<string> | null
default:not_ready
Available options:
not_ready,
queued,
in_progress,
completed,
failed
​
thumbnail_url
string | null
​
in_progress_at
string<date-time> | null