Soul Standard uses the model ID higgsfield-ai/soul/standard. Create original images from written prompts with Soul Standard.
1. Calling the API
Send requests to https://api.higgsfield.ai/higgsfield-ai/soul/standard with a JSON body matching the parameters below.
Install
Install an official server-side SDK. cURL needs no package.
npm install @higgsfield/clientSetup
Keep credentials in server-side environment variables. The SDKs accept the same KEY_ID:KEY_SECRET value under their documented variable names.
export HF_CREDENTIALS="YOUR_KEY_ID:YOUR_KEY_SECRET" # TypeScript
export HF_KEY="YOUR_KEY_ID:YOUR_KEY_SECRET" # Python and cURLRequest parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
seed | integer | No | null | Seed. Minimum: 1. Maximum: 1000000. |
prompt | string | Yes | — | Prompt. |
style_id | string | No | null | Soul Style. |
batch_size | integer | No | 1 | Result images. Options: 1, 4. |
resolution | string | No | "720p" | Resolution. Options: 720p, 1080p. |
aspect_ratio | string | No | "4:3" | Aspect Ratio. Options: 9:16, 16:9, 4:3, 3:4, 1:1, 2:3, 3:2. |
enhance_prompt | boolean | No | true | Enhance Prompt. |
style_strength | number | No | 1 | Style strength. Minimum: 0. Maximum: 1. |
2. Authentication
The official SDKs read credentials from the server environment and send the required Authorization: Key KEY_ID:KEY_SECRET header.
API Key
Never expose the secret in browser-side code or commit it to source control. The TypeScript SDK is server-side only. For direct HTTP calls, use:
Authorization: Key $HF_KEY3. Queue
subscribe submits the asynchronous request and waits for a terminal result. The TypeScript SDK polls automatically when withPolling: true; the Python SDK's synchronous subscribe call also waits. A completed request returns generated files in the images array.
Submit and wait
import { config, higgsfield } from "@higgsfield/client/v2";
config({
credentials: process.env.HF_CREDENTIALS,
});
const result = await higgsfield.subscribe(
"higgsfield-ai/soul/standard",
{
input: {
"seed": null,
"prompt": "A cinematic scene at sunset",
"style_id": null,
"batch_size": 1,
"resolution": "720p",
"aspect_ratio": "4:3",
"enhance_prompt": true,
"style_strength": 1
},
withPolling: true,
},
);
console.log(result);Explicit lifecycle control
Use the Python SDK when a worker needs explicit status, result, or cancellation control for an existing request. The TypeScript v2 client currently exposes automatic polling through subscribe.
import higgsfield_client
request_id = "{request_id}"
status = higgsfield_client.status(request_id=request_id)
result = higgsfield_client.result(request_id=request_id)
higgsfield_client.cancel(request_id=request_id)