Skip to content

Integrations

Higgsfield

Generate images and videos with Higgsfield models

Higgsfield is an image and video generation platform with its own SOUL image models and hosted models from other providers, such as Kling, Seedance, Wan, and MiniMax.

With the Higgsfield block, you can:

  • Generate media with any model: Send a model endpoint ID and that model's documented JSON input, then get back image, video, or audio URLs.
  • Generate SOUL images: Set aspect ratio, resolution, style, and a trained character without writing JSON.
  • Train characters: Create, check, list, and delete Soul ID characters from reference photo URLs to keep a person or mascot consistent across images.
  • Manage requests: Check the status of a request, cancel one that is still queued, or delete a finished request's data.

Create an API key in the Higgsfield Console, then connect it as a saved Higgsfield account in Sim. Paste the key ID and secret joined by a colon: KEY_ID:KEY_SECRET.

Generation runs in the background. By default the block waits for the result. Turn off Wait for Result to return the request ID right away, then use Get Request Status later. Output URLs expire after seven days by default, so copy media you need to keep. Which models you can use depends on your Higgsfield account; find endpoint IDs and their input fields in the model catalog.

In Sim, the Higgsfield block lets your agents produce product videos, ad creatives, and on-brand character images from a brief or a table of products.

Use the block

Generate images and videos with any Higgsfield model, create SOUL images with styles and trained characters, train and manage Soul ID characters, and check, cancel, or delete generation requests.

Actions

Higgsfield Generate

Submit a generation request to any Higgsfield image or video model endpoint with that model's documented JSON input, then wait for the output URLs.

Inputs and outputs

Input

ParameterTypeRequiredDescription
modelstringYesModel endpoint ID from the Higgsfield model catalog, e.g. kling-video/v2.5-turbo/pro/text-to-video
inputjsonYesJSON request body documented for the model endpoint, e.g. {"prompt": "...", "duration": 5}
waitForCompletionbooleanNoWait until the request finishes and return its output URLs. When false, return the request ID immediately.
webhookUrlstringNoHTTPS endpoint that Higgsfield notifies when the request finishes
idempotencyKeystringNoKey that makes retries return the original request instead of creating a duplicate (1–255 visible ASCII characters)
expiresAfternumberNoSeconds to keep the request data after it finishes, from 3600 up to the account retention

Output

ParameterTypeDescription
requestIdstringHiggsfield request ID
statusstringRequest status: queued, in_progress, completed, failed, nsfw, or canceled
errorstringFailure reason, when provided
imageUrlsarrayGenerated image URLs (image models)
videoUrlstringGenerated video URL (video models)
audioUrlstringGenerated audio URL (audio output)
audioUrlsarrayGenerated audio URLs (audio output)
statusUrlstringURL for checking the request status
cancelUrlstringURL for canceling the queued request
expiresAtstringWhen the output files are deleted and their URLs stop working

Higgsfield Generate SOUL Image

Generate images with Higgsfield SOUL, optionally in a style or as a trained Soul ID character, then wait for the image URLs.

Inputs and outputs

Input

ParameterTypeRequiredDescription
promptstringYesText description of the image
aspectRatiostringNoAspect ratio: 9:16, 16:9, 4:3, 3:4, 1:1, 2:3, or 3:2 (default 4:3)
resolutionstringNoResolution: 720p or 1080p (default 720p)
batchSizenumberNoNumber of images: 1 or 4 (default 1)
styleIdstringNoSOUL style UUID (defaults to the general style)
styleStrengthnumberNoStyle strength from 0 to 1 (default 1)
characterIdstringNoCompleted Soul ID character reference ID (model version v1) owned by the account
characterStrengthnumberNoCharacter strength from 0 to 1; 0 uses the style's default (default 1)
imageReferenceUrlstringNoPublic image URL that guides prompt enhancement
enhancePromptbooleanNoLet Higgsfield enhance the prompt (default false)
seednumberNoSeed from 1 to 1000000 for repeatable results
waitForCompletionbooleanNoWait until the request finishes and return its output URLs. When false, return the request ID immediately.
webhookUrlstringNoHTTPS endpoint that Higgsfield notifies when the request finishes
idempotencyKeystringNoKey that makes retries return the original request instead of creating a duplicate (1–255 visible ASCII characters)
expiresAfternumberNoSeconds to keep the request data after it finishes, from 3600 up to the account retention

Output

ParameterTypeDescription
requestIdstringHiggsfield request ID
statusstringRequest status: queued, in_progress, completed, failed, nsfw, or canceled
errorstringFailure reason, when provided
imageUrlsarrayGenerated image URLs (image models)
videoUrlstringGenerated video URL (video models)
audioUrlstringGenerated audio URL (audio output)
audioUrlsarrayGenerated audio URLs (audio output)
statusUrlstringURL for checking the request status
cancelUrlstringURL for canceling the queued request
expiresAtstringWhen the output files are deleted and their URLs stop working

Higgsfield Get Request Status

Get the status of a Higgsfield generation request and, once completed, its output URLs.

Inputs and outputs

Input

ParameterTypeRequiredDescription
requestIdstringYesHiggsfield request ID returned by a generation request

Output

ParameterTypeDescription
requestIdstringHiggsfield request ID
statusstringRequest status: queued, in_progress, completed, failed, nsfw, or canceled
errorstringFailure reason, when provided
imageUrlsarrayGenerated image URLs (image models)
videoUrlstringGenerated video URL (video models)
audioUrlstringGenerated audio URL (audio output)
audioUrlsarrayGenerated audio URLs (audio output)
statusUrlstringURL for checking the request status
cancelUrlstringURL for canceling the queued request
expiresAtstringWhen the output files are deleted and their URLs stop working

Higgsfield Cancel Request

Cancel a Higgsfield generation request that is still queued. Requests that have started processing cannot be canceled.

Inputs and outputs

Input

ParameterTypeRequiredDescription
requestIdstringYesHiggsfield request ID to cancel

Output

ParameterTypeDescription
requestIdstringID of the canceled request
canceledbooleanWhether the request was canceled

Higgsfield Delete Request

Immediately delete a finished Higgsfield request's output files, prompt, and parameters.

Inputs and outputs

Input

ParameterTypeRequiredDescription
requestIdstringYesID of a finished Higgsfield request

Output

ParameterTypeDescription
requestIdstringID of the deleted request
deletedbooleanWhether the request data was deleted

Higgsfield Create Character

Train a reusable Soul ID character from public reference image URLs. Training runs in the background; use Get Character to check when it completes.

Inputs and outputs

Input

ParameterTypeRequiredDescription
namestringYesCharacter name (up to 100 characters)
modelVersionstringNoSOUL family that will use the character: v1, v2, or cinema (default v1)
imageUrlsarrayYes1 to 100 public URLs of reference photos of the character

Output

ParameterTypeDescription
characterjsonCreated character reference
↳ idstringCharacter (Soul ID) reference ID
↳ namestringCharacter name
↳ modelVersionstringSOUL family: v1, v2, or cinema
↳ statusstringTraining status: not_ready, queued, in_progress, completed, or failed
↳ thumbnailUrlstringThumbnail image URL
↳ createdAtstringCreation timestamp
↳ inProgressAtstringTraining start timestamp
↳ failReasonstringTraining failure reason

Higgsfield Get Character

Get a Soul ID character reference, including its training status.

Inputs and outputs

Input

ParameterTypeRequiredDescription
characterIdstringYesSoul ID character reference ID

Output

ParameterTypeDescription
characterjsonCharacter reference
↳ idstringCharacter (Soul ID) reference ID
↳ namestringCharacter name
↳ modelVersionstringSOUL family: v1, v2, or cinema
↳ statusstringTraining status: not_ready, queued, in_progress, completed, or failed
↳ thumbnailUrlstringThumbnail image URL
↳ createdAtstringCreation timestamp
↳ inProgressAtstringTraining start timestamp
↳ failReasonstringTraining failure reason

Higgsfield List Characters

List the Soul ID character references in the Higgsfield account, one page at a time.

Inputs and outputs

Input

ParameterTypeRequiredDescription
pagenumberNoPage number, starting at 1 (default 1)
pageSizenumberNoCharacters per page (default 20)

Output

ParameterTypeDescription
charactersarrayCharacter references on this page
↳ idstringCharacter (Soul ID) reference ID
↳ namestringCharacter name
↳ modelVersionstringSOUL family: v1, v2, or cinema
↳ statusstringTraining status: not_ready, queued, in_progress, completed, or failed
↳ thumbnailUrlstringThumbnail image URL
↳ createdAtstringCreation timestamp
↳ inProgressAtstringTraining start timestamp
↳ failReasonstringTraining failure reason
totalnumberTotal number of characters
pagenumberCurrent page number
pageSizenumberCharacters per page
totalPagesnumberTotal number of pages

Higgsfield Delete Character

Permanently delete a Soul ID character reference.

Inputs and outputs

Input

ParameterTypeRequiredDescription
characterIdstringYesSoul ID character reference ID to delete

Output

ParameterTypeDescription
characterIdstringID of the deleted character
deletedbooleanWhether the character was deleted
Was this helpful?
Suggest an edit