nicolascoutureau/gs | API reference

Public

3.5K runs

Run nicolascoutureau/gs 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
image	string		Input image to animate
animation_type	None	rotate_forward	Type of camera animation
duration	number	3 Min: 1 Max: 10	Duration of the output video in seconds
fps	integer	24 Min: 15 Max: 60	Frames per second for the output video
render_resolution	integer	1024 Min: 256 Max: 1280	Render resolution (lower = faster). 512 is fast, 768 balanced, 1024 high quality
max_disparity	number	0.12 Min: 0.02 Max: 0.5	Maximum lateral camera movement (higher = more 3D parallax effect)
max_zoom	number	0.2 Min: 0.05 Max: 0.6	Maximum zoom/depth movement (higher = more push in/out)
camera_distance	number	0 Min: -0.5 Max: 0.5	Camera distance from subject (0 = natural, negative = closer, positive = farther)
lookat_mode	None	point	Camera look-at mode: 'point' looks at center, 'ahead' looks straight

{
  "type": "object",
  "title": "Input",
  "required": [
    "image"
  ],
  "properties": {
    "fps": {
      "type": "integer",
      "title": "Fps",
      "default": 24,
      "maximum": 60,
      "minimum": 15,
      "x-order": 3,
      "description": "Frames per second for the output video"
    },
    "image": {
      "type": "string",
      "title": "Image",
      "format": "uri",
      "x-order": 0,
      "description": "Input image to animate"
    },
    "duration": {
      "type": "number",
      "title": "Duration",
      "default": 3,
      "maximum": 10,
      "minimum": 1,
      "x-order": 2,
      "description": "Duration of the output video in seconds"
    },
    "max_zoom": {
      "type": "number",
      "title": "Max Zoom",
      "default": 0.2,
      "maximum": 0.6,
      "minimum": 0.05,
      "x-order": 6,
      "description": "Maximum zoom/depth movement (higher = more push in/out)"
    },
    "lookat_mode": {
      "enum": [
        "point",
        "ahead"
      ],
      "type": "string",
      "title": "lookat_mode",
      "description": "Camera look-at mode: 'point' looks at center, 'ahead' looks straight",
      "default": "point",
      "x-order": 8
    },
    "max_disparity": {
      "type": "number",
      "title": "Max Disparity",
      "default": 0.12,
      "maximum": 0.5,
      "minimum": 0.02,
      "x-order": 5,
      "description": "Maximum lateral camera movement (higher = more 3D parallax effect)"
    },
    "animation_type": {
      "enum": [
        "rotate_forward",
        "rotate",
        "swipe",
        "shake"
      ],
      "type": "string",
      "title": "animation_type",
      "description": "Type of camera animation",
      "default": "rotate_forward",
      "x-order": 1
    },
    "camera_distance": {
      "type": "number",
      "title": "Camera Distance",
      "default": 0,
      "maximum": 0.5,
      "minimum": -0.5,
      "x-order": 7,
      "description": "Camera distance from subject (0 = natural, negative = closer, positive = farther)"
    },
    "render_resolution": {
      "type": "integer",
      "title": "Render Resolution",
      "default": 1024,
      "maximum": 1280,
      "minimum": 256,
      "x-order": 4,
      "description": "Render resolution (lower = faster). 512 is fast, 768 balanced, 1024 high quality"
    }
  }
}

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"
}