nghimestudio/nghivideo | API reference

Public

6 runs

Run nghimestudio/nghivideo with an API

Use one of our client libraries to get started quickly. Clicking on a library will take you to the Playground tab where you can tweak different inputs, see the results, and copy the corresponding code to use in your own project.

Input schema

The fields you can use to run this model with an API. If you don't give a value for a field its default value will be used.

Field	Type	Default value	Description
quality	None	standard	Encode quality preset.
format	None	mp4	Output container/format.
fps	integer	30 Min: 1 Max: 120	Frame rate (1–120).
workers	string	1	Parallel Chrome workers: number or 'auto'. Use 1 on small machines.
resolution	string		Optional resolution preset (empty = composition native). Examples: landscape, portrait, square, landscape-4k, portrait-4k.
composition	string		ZIP of a HyperFrames project. Must contain index.html (and typically assets/). Same layout as hyperframes init / render.
variables_json	string		Optional JSON object for --variables, e.g. {"title":"Hello"}.
browser_timeout	integer	120 Min: 30 Max: 600	Page navigation timeout in seconds.
composition_url	string		Optional HTTPS URL to a .zip of the composition (alternative to file upload).
low_memory_mode	boolean	True	Pin 1 worker + screenshot capture (recommended on Replicate CPU).

{
  "type": "object",
  "title": "Input",
  "properties": {
    "fps": {
      "type": "integer",
      "title": "Fps",
      "default": 30,
      "maximum": 120,
      "minimum": 1,
      "description": "Frame rate (1\u2013120)."
    },
    "format": {
      "enum": [
        "mp4",
        "webm",
        "mov",
        "gif"
      ],
      "type": "string",
      "title": "format",
      "description": "Output container/format.",
      "default": "mp4",
      "x-order": 4
    },
    "quality": {
      "enum": [
        "draft",
        "standard",
        "high"
      ],
      "type": "string",
      "title": "quality",
      "description": "Encode quality preset.",
      "default": "standard",
      "x-order": 3
    },
    "workers": {
      "type": "string",
      "title": "Workers",
      "default": "1",
      "description": "Parallel Chrome workers: number or 'auto'. Use 1 on small machines."
    },
    "resolution": {
      "type": "string",
      "title": "Resolution",
      "default": "",
      "description": "Optional resolution preset (empty = composition native). Examples: landscape, portrait, square, landscape-4k, portrait-4k."
    },
    "composition": {
      "type": "string",
      "title": "Composition",
      "format": "uri",
      "description": "ZIP of a HyperFrames project. Must contain index.html (and typically assets/). Same layout as hyperframes init / render."
    },
    "variables_json": {
      "type": "string",
      "title": "Variables Json",
      "default": "",
      "description": "Optional JSON object for --variables, e.g. {\"title\":\"Hello\"}."
    },
    "browser_timeout": {
      "type": "integer",
      "title": "Browser Timeout",
      "default": 120,
      "maximum": 600,
      "minimum": 30,
      "description": "Page navigation timeout in seconds."
    },
    "composition_url": {
      "type": "string",
      "title": "Composition Url",
      "default": "",
      "description": "Optional HTTPS URL to a .zip of the composition (alternative to file upload)."
    },
    "low_memory_mode": {
      "type": "boolean",
      "title": "Low Memory Mode",
      "default": true,
      "description": "Pin 1 worker + screenshot capture (recommended on Replicate CPU)."
    }
  }
}

Output schema

The shape of the response you’ll get when you run this model with an API.

Schema

{
  "type": "string",
  "title": "Output",
  "format": "uri"
}