deforum/shap-e – API reference

deforum / shap-e

Public
107 runs

Run deforum/shap-e 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
prompt	string		Text prompt for generating the 3D model, ignored if an image is provide below
image	string		A synthetic view image for generating the 3D modeld. To get the best result, remove background from the input image
guidance_scale	number	15	Set the scale for guidanece
batch_size	integer	1	Number of output
render_mode	string (enum)	nerf Options: nerf, stf	Choose a render mode
render_size	integer	128	Set the size of the a renderer, higher values take longer to render
save_mesh	boolean	False	Save the latents as meshes.

{
  "type": "object",
  "title": "Input",
  "properties": {
    "image": {
      "type": "string",
      "title": "Image",
      "format": "uri",
      "x-order": 1,
      "description": "A synthetic view image for generating the 3D modeld. To get the best result, remove background from the input image"
    },
    "prompt": {
      "type": "string",
      "title": "Prompt",
      "x-order": 0,
      "description": "Text prompt for generating the 3D model, ignored if an image is provide below"
    },
    "save_mesh": {
      "type": "boolean",
      "title": "Save Mesh",
      "default": false,
      "x-order": 6,
      "description": "Save the latents as meshes."
    },
    "batch_size": {
      "type": "integer",
      "title": "Batch Size",
      "default": 1,
      "x-order": 3,
      "description": "Number of output"
    },
    "render_mode": {
      "enum": [
        "nerf",
        "stf"
      ],
      "type": "string",
      "title": "render_mode",
      "description": "Choose a render mode",
      "default": "nerf",
      "x-order": 4
    },
    "render_size": {
      "type": "integer",
      "title": "Render Size",
      "default": 128,
      "x-order": 5,
      "description": "Set the size of the a renderer, higher values take longer to render"
    },
    "guidance_scale": {
      "type": "number",
      "title": "Guidance Scale",
      "default": 15,
      "x-order": 2,
      "description": "Set the scale for guidanece"
    }
  }
}

Output schema

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

Schema

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