Skip to main content
Higgsfield logo
  • Category: media generation
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 14
  • Triggers: 0
  • Slug: HIGGSFIELD
  • Version: 20261101_00
  • Instant: Supported on the latest version. Support varies by tool.

Tools

Slug: HIGGSFIELD_CANCEL_REQUESTCancel a Higgsfield generation request while it is still queued; requests already processing or finished cannot be canceled. Managed generation requests cannot be canceled.

Input Parameters

string
required
Queued generation request ID returned by a generation action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGGSFIELD_CREATE_CHARACTER_REFERENCEStart training a reusable Higgsfield Soul ID character reference from one or more public images using your connected account. The returned ID can be used to check training status.

Input Parameters

string
required
Name of the character reference (maximum 100 characters).
array
required
One to 100 public images used to train the character reference.
string ("v1" | "v2" | "cinema")
SOUL model family that will use the character reference.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGGSFIELD_ESTIMATE_SOUL_V2_COSTEstimate your connected account’s credit and USD cost for a Higgsfield Soul V2 Standard image request without starting generation.

Input Parameters

integer
Optional deterministic generation seed from 1 to 1000000. Omit it to let Higgsfield choose a random seed.
string
required
Text instructions for the image generation request to estimate.
string
Identifier of a style supported by Soul V2.
integer ("1" | "4")
Number of output images. Soul V2 supports only 1 or 4.
string ("720p" | "1080p")
Output resolution tier.
string ("9:16" | "16:9" | "4:3" | "3:4" | "1:1" | "2:3" | "3:2")
Output width-to-height ratio.
boolean
Whether Higgsfield should enhance the prompt.
number
Style strength from 0 to 1. Higgsfield currently accepts this field without applying it to generation.
string
Optional identifier of a completed character reference owned by the connected account.
number
Character-reference strength from 0 to 1. When custom_reference_id is set, this must be greater than 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGGSFIELD_GENERATE_CONTENT_BY_MODEL_IDSubmit a generation request using an allowed Higgsfield model route and your connected account, returning a request ID for status polling. This fallback is deprecated.

Input Parameters

string
required
The text prompt describing what to generate
integer
Duration in seconds for video generation models
string ("reve/text-to-image")
required
Deprecated fallback model route not covered by a typed action. Existing legacy model IDs remain accepted for compatibility but are not advertised.
string
Public input image URL for image-to-video or image-to-image models
string
Provider-supported output resolution
string
Public HTTPS URL for notification when generation finishes
string
Aspect ratio for the output, such as 16:9, 1:1, 9:16, or 4:3

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGGSFIELD_GENERATE_IMAGE_WITH_REFERENCESSubmit a Higgsfield Popcorn request that uses one or more reference images and return the request ID used to track the asynchronous result. Managed estimates above $2 are rejected before generation submission. No polling is performed; use the returned request ID with GET_REQUEST_STATUS. Managed generation charges the upfront estimate when submission is accepted, including if generation later fails. Managed requests cannot be canceled.Instant: Supported on the latest version.Instant pricing: Popcorn Auto: varies by references, count and resolution; $2 max per request.

Input Parameters

integer
Optional deterministic generation seed (1-1000000).
string
required
Text description of the image to generate using the references.
array
required
Public URLs of 1-8 reference images. Each image must already be publicly accessible over HTTP or HTTPS.
integer
Number of images to generate (1-8).
string ("720p" | "1600p")
Output quality.
string
Optional public HTTPS URL that receives the terminal completed, failed, or nsfw payload.
string ("1:1" | "4:3" | "3:4" | "3:2" | "2:3" | "16:9" | "9:16")
Aspect ratio of each generated image.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGGSFIELD_GENERATE_SEEDANCE_2_5_IMAGE_VIDEOSubmit a ByteDance Seedance 2.5 image-to-video request through Higgsfield and return a request ID for tracking. Managed formula estimates use requested duration and a provisional reference-frame area and may differ from final supplier usage. Managed estimates above $2.50 are rejected before generation submission. No polling is performed; use the returned request ID with GET_REQUEST_STATUS. Managed generation charges the upfront estimate when submission is accepted, including if generation later fails. Managed requests cannot be canceled.Instant: Supported on the latest version.Instant pricing: Seedance 2.5 image-to-video uses a numeric quote or a provisional 480p/720p reference-frame estimate at $2.140 per 100,000 video tokens before discounts. Estimates above $2.50 are rejected. Reference frame area may differ from the generated video.

Input Parameters

string
Optional description of the desired scene and motion.
integer
Requested output duration in seconds (4-30).
string
required
Public URL of the starting image to animate.
string ("480p" | "720p" | "1080p")
Output resolution tier.
string
Optional public URL of the desired final frame.
string ("mp4" | "mov")
Video container format.
boolean
Whether to generate audio with the video.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGGSFIELD_GENERATE_SEEDANCE_2_5_TEXT_VIDEOSubmit a ByteDance Seedance 2.5 text-to-video request through Higgsfield using the connected API key and return the request ID used to track the asynchronous result with GET_REQUEST_STATUS. Formula estimates use requested duration and estimated dimensions, and may differ from the final provider bill. Managed estimates above $2.50 are rejected before generation submission. No polling is performed; use the returned request ID with GET_REQUEST_STATUS. Managed generation charges the upfront estimate when submission is accepted, including if generation later fails. Managed requests cannot be canceled.Instant: Supported on the latest version.Instant pricing: Seedance 2.5 uses a numeric quote or a 16:9 480p/720p upfront estimate at $2.140 per 100,000 video tokens before discounts. Estimates above $2.50 are rejected; other variants require a numeric quote.

Input Parameters

string
required
Text description of the video to generate.
integer
Requested output duration in seconds (4-30).
string ("480p" | "720p" | "1080p")
Output resolution tier.
string ("16:9" | "4:3" | "1:1" | "3:4" | "9:16" | "21:9")
Output width-to-height ratio.
string ("mp4" | "mov")
Video container format.
boolean
Whether to generate audio with the video.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGGSFIELD_GENERATE_SEEDANCE_2_TEXT_VIDEOSubmit a ByteDance Seedance 2.0 text-to-video request through Higgsfield and return the request handle used to track the asynchronous result. Managed estimates above $2 are rejected before generation submission. No polling is performed; use the returned request ID with GET_REQUEST_STATUS. Managed generation charges the upfront estimate when submission is accepted, including if generation later fails. Managed requests cannot be canceled.

Input Parameters

string
required
Text description of the video to generate.
integer
Requested output duration in seconds (4-15).
string ("480p" | "720p" | "1080p" | "4k")
Output resolution tier.
string
Optional public HTTPS URL that receives the terminal completed, failed, or nsfw payload.
string ("16:9" | "4:3" | "1:1" | "3:4" | "9:16" | "21:9")
Output width-to-height ratio.
boolean
Whether to generate audio with the video.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGGSFIELD_GENERATE_SOUL_STANDARD_IMAGESubmit a text-to-image request to Higgsfield Soul Standard and return the request ID used to track the asynchronous result. Managed estimates above $2 are rejected before generation submission. No polling is performed; use the returned request ID with GET_REQUEST_STATUS. Managed generation charges the upfront estimate when submission is accepted, including if generation later fails. Managed requests cannot be canceled.Instant: Supported on the latest version.Instant pricing: Soul Standard: varies by resolution and image count; $2 max per request.

Input Parameters

integer
Optional deterministic generation seed (1-1000000).
string
required
Text description of the image to generate.
string
Identifier of a style supported by Soul Standard.
integer ("1" | "4")
Number of output images. Soul Standard supports only 1 or 4.
string ("720p" | "1080p")
Output resolution. Use 720p or 1080p.
string
Optional public HTTPS URL that receives the terminal completed, failed, or nsfw payload.
string ("9:16" | "16:9" | "4:3" | "3:4" | "1:1" | "2:3" | "3:2")
Output width-to-height ratio.
boolean
Whether Higgsfield should enhance the prompt before generation.
number
Strength of the selected style (0-1).
string
Optional identifier of a completed character reference owned by the account.
string
Optional public image URL used to guide prompt enhancement.
number
Strength of the character reference (0-1). Zero uses the selected style’s default character strength.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGGSFIELD_GENERATE_SOUL_V2_IMAGESubmit a text-to-image request to Higgsfield Soul V2 and return the request ID used to track the asynchronous result. Managed estimates above $2 are rejected before generation submission. No polling is performed; use the returned request ID with GET_REQUEST_STATUS. Managed generation charges the upfront estimate when submission is accepted, including if generation later fails. Managed requests cannot be canceled.Instant: Supported on the latest version.Instant pricing: Soul V2: varies by resolution and image count; $2 max per request.

Input Parameters

integer
Optional deterministic generation seed (1-1000000). Omit to use a random seed.
string
required
Text description of the image to generate.
string
Identifier of a style supported by Soul V2.
integer ("1" | "4")
Number of output images. Soul V2 supports only 1 or 4.
string ("720p" | "1080p")
Output resolution tier.
string
Optional public HTTPS URL that receives the terminal completed, failed, or nsfw payload.
string ("9:16" | "16:9" | "4:3" | "3:4" | "1:1" | "2:3" | "3:2")
Output width-to-height ratio.
boolean
Whether Higgsfield should enhance the prompt before generation.
number
Strength of the selected style (0-1). This parameter currently has no effect on generation.
string
Optional identifier of a completed character reference owned by the account.
number
Strength of the character reference (0-1). Must be greater than 0 when custom_reference_id is supplied.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGGSFIELD_GENERATE_VIDEO_FROM_IMAGEGenerate a video from a publicly accessible starting image with Higgsfield DOP Lite and return the request ID used to track the asynchronous result. Managed estimates above $2 are rejected before generation submission. No polling is performed; use the returned request ID with GET_REQUEST_STATUS. Managed generation charges the upfront estimate when submission is accepted, including if generation later fails. Managed requests cannot be canceled.Instant: Supported on the latest version.Instant pricing: DOP Lite video: up to $2 per request.

Input Parameters

integer
Optional deterministic generation seed (1-1000000).
string
required
Text description of the desired motion and scene.
string
required
Public HTTP or HTTPS URL of the first-frame image to animate. The image must already be publicly accessible.
string
Optional public HTTPS URL that receives the terminal completed, failed, or nsfw payload.
string
Optional public HTTP or HTTPS URL of the desired final frame. The image must already be publicly accessible.
boolean
Whether Higgsfield should enhance the prompt before generation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGGSFIELD_GET_CHARACTER_REFERENCEGet a Higgsfield Soul ID character reference and its current training status by ID using your connected account.

Input Parameters

string
required
Character-reference UUID returned by CREATE_CHARACTER_REFERENCE.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGGSFIELD_GET_REQUEST_STATUSGet the current state of a Higgsfield generation request and return generated image, video, or audio URLs when complete.Instant: Supported on the latest version.Instant pricing: $0 per request

Input Parameters

string
required
Generation request ID returned by a Higgsfield generation action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGGSFIELD_LIST_SOUL_V2_STYLESList SOUL V2 image styles available to your connected Higgsfield account, including style IDs for SOUL V2 generation requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not