GET
/
v1
/
custom-references
/
{reference_id}
Get character
curl --request GET \
  --url https://platform.higgsfield.ai/v1/custom-references/{reference_id} \
  --header 'hf-api-key: <hf-api-key>' \
  --header 'hf-secret: <hf-secret>'
{
  "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",
  "reference_media": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "media_url": "<string>"
    }
  ]
}

Headers

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

Path Parameters

​
reference_id
string<uuid>
required

Response

Successful Response

​
id
string<uuid>
required
​
name
string
required
Maximum length: 100
​
created_at
string<date-time>
required
​
reference_media
AccountCustomReferenceMedia · object[]
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