{
  "openapi": "3.0.1",
  "info": {
    "title": "HiggsField API (Seedance 2.5)",
    "description": "Generate HiggsField (ByteDance) Seedance 2.5 videos from Apify, n8n, Make or your own code, paid with the Higgsfield subscription you already have. Text to video, image, audio and video references, video edit and video extension, 480p to 1080p, 4 to 30 seconds.",
    "version": "0.1",
    "x-build-id": "C3lsvMwpGkebAL9gP"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/mrbuslov~higgsfield-apify-proxy/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-mrbuslov-higgsfield-apify-proxy",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/mrbuslov~higgsfield-apify-proxy/runs": {
      "post": {
        "operationId": "runs-sync-mrbuslov-higgsfield-apify-proxy",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/mrbuslov~higgsfield-apify-proxy/run-sync": {
      "post": {
        "operationId": "run-sync-mrbuslov-higgsfield-apify-proxy",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "required": [
          "action"
        ],
        "properties": {
          "action": {
            "title": "What to do",
            "enum": [
              "generate",
              "connect",
              "status",
              "disconnect"
            ],
            "type": "string",
            "description": "Start with <b>Connect my Higgsfield account</b> once. The run log then shows a link to a short step-by-step page.",
            "default": "generate"
          },
          "prompt": {
            "title": "Prompt",
            "type": "string",
            "description": "What should happen in the video."
          },
          "mode": {
            "title": "Mode",
            "enum": [
              "t2v",
              "omni_reference",
              "video_edit",
              "video_extension"
            ],
            "type": "string",
            "description": "Text to video takes a prompt only. Reference mode needs at least one file below. Video edit needs exactly one video. Video extension needs a video and a direction.",
            "default": "t2v"
          },
          "resolution": {
            "title": "Resolution",
            "enum": [
              "480p",
              "720p",
              "1080p"
            ],
            "type": "string",
            "description": "Higgsfield credits per second: 480p = 3, 720p = 6.5, 1080p = 9.",
            "default": "720p"
          },
          "aspect_ratio": {
            "title": "Aspect ratio",
            "enum": [
              "16:9",
              "9:16",
              "1:1",
              "4:3",
              "3:4",
              "21:9",
              "auto"
            ],
            "type": "string",
            "description": "Shape of the video. 16:9 is landscape, 9:16 is vertical for phones.",
            "default": "16:9"
          },
          "duration": {
            "title": "Duration (seconds)",
            "minimum": 4,
            "maximum": 30,
            "type": "integer",
            "description": "Whole seconds, 4 to 30.",
            "default": 5
          },
          "generate_audio": {
            "title": "Generate sound",
            "type": "boolean",
            "description": "Let Seedance add sound and speech to the video.",
            "default": true
          },
          "bitrate_mode": {
            "title": "Bitrate",
            "enum": [
              "standard",
              "high"
            ],
            "type": "string",
            "description": "'high' gives a larger, sharper file at the same credit price.",
            "default": "standard"
          },
          "extension_mode": {
            "title": "Extension direction",
            "enum": [
              "forward",
              "backward"
            ],
            "type": "string",
            "description": "Only for 'Extend a video'."
          },
          "start_image_url": {
            "title": "Start image URL",
            "type": "string",
            "description": "Reference mode only. Public link to a PNG, JPG or WEBP."
          },
          "end_image_url": {
            "title": "End image URL",
            "type": "string",
            "description": "Reference mode only."
          },
          "image_reference_urls": {
            "title": "Reference images",
            "type": "array",
            "description": "Public links. Up to 30 images in total, start and end image included.",
            "items": {
              "type": "string"
            }
          },
          "video_reference_urls": {
            "title": "Reference videos",
            "type": "array",
            "description": "Public links to MP4, MOV or WEBM.",
            "items": {
              "type": "string"
            }
          },
          "audio_reference_urls": {
            "title": "Reference audio",
            "type": "array",
            "description": "Public links to MP3, WAV, M4A, AAC or OGG.",
            "items": {
              "type": "string"
            }
          },
          "save_video_to_storage": {
            "title": "Also save the video file in this run's storage",
            "type": "boolean",
            "description": "The Higgsfield link is permanent, but a copy in Apify storage is handy for downstream Actors.",
            "default": false
          },
          "max_wait_minutes": {
            "title": "Stop waiting after (minutes)",
            "minimum": 5,
            "maximum": 60,
            "type": "integer",
            "description": "A video usually takes 3 to 9 minutes.",
            "default": 45
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}