Genjutsu — API reference

Genjutsu Object Swap uses the model ID higgsfield/genjutsu/object-swap/v1.0. The source video must be at least 4 seconds. Videos longer than 30 seconds are trimmed to 30 seconds; output duration follows the prepared source video. Provide 1–8 image references. The prompt is optional and defaults to an empty string. The source video must contain at least 409,600 pixels per frame (width × height).

1. Calling the API

Send requests to https://api.higgsfield.ai/higgsfield/genjutsu/object-swap/v1.0 with a JSON body matching the parameters below.

Install

Install an official server-side SDK. cURL needs no package.

npm install @higgsfield/client

Setup

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 cURL

Request parameters

Parameter	Type	Required	Default	Description
`prompt`	`string`	No	`""`	Prompt. Maximum length: 10000.
`video_url`	`string`	Yes	`—`	Video Url. Minimum length: 1. Maximum length: 2083.
`image_urls`	`array[string]`	Yes	`—`	Image Urls.
`resolution`	`string`	No	`"720p"`	Resolution. Options: 720p, 480p, 1080p.

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_KEY

3. 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 the generated file in the video field.

Submit and wait

import { config, higgsfield } from "@higgsfield/client/v2";

config({
  credentials: process.env.HF_CREDENTIALS,
});

const result = await higgsfield.subscribe(
  "higgsfield/genjutsu/object-swap/v1.0",
  {
    input: {
      "prompt": "",
      "video_url": "https://example.com/input.mp4",
      "image_urls": [
        "https://example.com/input.jpg"
      ],
      "resolution": "720p"
    },
    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)