/templates/featured

curl --request GET \
  --url https://api.shadeform.ai/v1/templates/featured \
  --header 'X-API-KEY: <api-key>'

{
  "templates": [
    {
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "name": "My AwesomeTemplate",
      "description": "A template for running vLLM",
      "author": "John Doe",
      "logo": "https://example.com/logo.png",
      "public": true,
      "launch_configuration": {
        "type": "docker",
        "docker_configuration": {
          "image": "vllm/vllm-openai:latest",
          "args": "--model mistralai/Mistral-7B-v0.1",
          "shared_memory_in_gb": 8,
          "envs": [
            {
              "name": "HUGGING_FACE_HUB_TOKEN",
              "value": "hugging_face_api_token"
            }
          ],
          "port_mappings": [
            {
              "host_port": 80,
              "container_port": 8000
            }
          ],
          "volume_mounts": [
            {
              "host_path": "~/.cache/huggingface",
              "container_path": "/root/.cache/huggingface"
            }
          ],
          "registry_credentials": {
            "username": "username",
            "password": "password"
          }
        },
        "script_configuration": {
          "base64_script": "IyEvYmluL2Jhc2gKCiMgRW5kbGVzcyBsb29wCndoaWxlIHRydWUKZG8KICAgICMgRmV0Y2ggYSBjYXQgZmFjdCB3aXRoIGEgbWF4aW11bSBsZW5ndGggb2YgMTQwIGNoYXJhY3RlcnMKICAgIGN1cmwgLS1uby1wcm9ncmVzcy1tZXRlciBodHRwczovL2NhdGZhY3QubmluamEvZmFjdD9tYXhfbGVuZ3RoPTE0MAoKICAgICMgUHJpbnQgYSBuZXdsaW5lIGZvciByZWFkYWJpbGl0eQogICAgZWNobwoKICAgICMgU2xlZXAgZm9yIDMgc2Vjb25kcyBiZWZvcmUgdGhlIG5leHQgaXRlcmF0aW9uCiAgICBzbGVlcCAzCmRvbmUKCgo="
        }
      },
      "auto_delete": {
        "date_threshold": "2006-01-02T15:04:05-07:00",
        "spend_threshold": "3.14"
      },
      "alert": {
        "date_threshold": "2006-01-02T15:04:05-07:00",
        "spend_threshold": "3.14"
      },
      "volume_mount": {
        "auto": true
      },
      "tags": [
        "tag1"
      ],
      "envs": [
        {
          "name": "HUGGING_FACE_HUB_TOKEN",
          "value": "hugging_face_api_token"
        }
      ],
      "networking": {
        "ufw_rules": [
          {
            "rule": "allow",
            "from_ip": "192.168.1.0/24",
            "to_ip": "10.0.0.0/8",
            "port": "80",
            "proto": "tcp"
          }
        ]
      }
    }
  ]
}

GET

templates

featured

/templates/featured

curl --request GET \
  --url https://api.shadeform.ai/v1/templates/featured \
  --header 'X-API-KEY: <api-key>'

{
  "templates": [
    {
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "name": "My AwesomeTemplate",
      "description": "A template for running vLLM",
      "author": "John Doe",
      "logo": "https://example.com/logo.png",
      "public": true,
      "launch_configuration": {
        "type": "docker",
        "docker_configuration": {
          "image": "vllm/vllm-openai:latest",
          "args": "--model mistralai/Mistral-7B-v0.1",
          "shared_memory_in_gb": 8,
          "envs": [
            {
              "name": "HUGGING_FACE_HUB_TOKEN",
              "value": "hugging_face_api_token"
            }
          ],
          "port_mappings": [
            {
              "host_port": 80,
              "container_port": 8000
            }
          ],
          "volume_mounts": [
            {
              "host_path": "~/.cache/huggingface",
              "container_path": "/root/.cache/huggingface"
            }
          ],
          "registry_credentials": {
            "username": "username",
            "password": "password"
          }
        },
        "script_configuration": {
          "base64_script": "IyEvYmluL2Jhc2gKCiMgRW5kbGVzcyBsb29wCndoaWxlIHRydWUKZG8KICAgICMgRmV0Y2ggYSBjYXQgZmFjdCB3aXRoIGEgbWF4aW11bSBsZW5ndGggb2YgMTQwIGNoYXJhY3RlcnMKICAgIGN1cmwgLS1uby1wcm9ncmVzcy1tZXRlciBodHRwczovL2NhdGZhY3QubmluamEvZmFjdD9tYXhfbGVuZ3RoPTE0MAoKICAgICMgUHJpbnQgYSBuZXdsaW5lIGZvciByZWFkYWJpbGl0eQogICAgZWNobwoKICAgICMgU2xlZXAgZm9yIDMgc2Vjb25kcyBiZWZvcmUgdGhlIG5leHQgaXRlcmF0aW9uCiAgICBzbGVlcCAzCmRvbmUKCgo="
        }
      },
      "auto_delete": {
        "date_threshold": "2006-01-02T15:04:05-07:00",
        "spend_threshold": "3.14"
      },
      "alert": {
        "date_threshold": "2006-01-02T15:04:05-07:00",
        "spend_threshold": "3.14"
      },
      "volume_mount": {
        "auto": true
      },
      "tags": [
        "tag1"
      ],
      "envs": [
        {
          "name": "HUGGING_FACE_HUB_TOKEN",
          "value": "hugging_face_api_token"
        }
      ],
      "networking": {
        "ufw_rules": [
          {
            "rule": "allow",
            "from_ip": "192.168.1.0/24",
            "to_ip": "10.0.0.0/8",
            "port": "80",
            "proto": "tcp"
          }
        ]
      }
    }
  ]
}

Authorizations

X-API-KEY

string

header

required

Response

200 - application/json

Returns a list of featured templates

templates

object[]

required

Show child attributes

templates.id

string

required

Unique identifier for the template, generated by Shadeform

Example:

"d290f1ee-6c54-4b01-90e6-d701748f0851"

templates.name

string

required

Name of the template

Example:

"My AwesomeTemplate"

templates.description

string

Description of the template

Example:

"A template for running vLLM"

templates.author

string

Author of the template

Example:

"John Doe"

templates.logo

string

URL to the template's logo

Example:

"https://example.com/logo.png"

templates.public

boolean

Whether the template is publicly available

Example:

true

templates.launch_configuration

object

Defines automatic actions after the instance becomes active.

Show child attributes

templates.launch_configuration.type

enum<string>

required

Specifies the type of launch configuration. See Launch Configuration for more details.

Available options:

docker,

script

Example:

"docker"

templates.launch_configuration.docker_configuration

object

May only be used if launch_configuration.type is 'docker'. Use docker_configuration to automatically pull and run a docker image. See this tutorial for examples.

Show child attributes

templates.launch_configuration.docker_configuration.image

string

required

Specifies the docker image to be pulled and run on the instance at startup.

Example:

"vllm/vllm-openai:latest"

templates.launch_configuration.docker_configuration.args

string

Specifies the container arguments passed into the image at runtime.

Example:

"--model mistralai/Mistral-7B-v0.1"

templates.launch_configuration.docker_configuration.shared_memory_in_gb

integer

Describes the amount of shared memory allocated for the container. Equivalent to using the --shm-size flag in the docker cli. If shared_memory_in_gb is not specified, then the container will use the host namespace which is the equivalent of --ipc=host.

Example:

8

templates.launch_configuration.docker_configuration.envs

object[]

List of environment variable name-value pairs that will be passed to the docker container.

Show child attributes

templates.launch_configuration.docker_configuration.envs.name

string

required

Name of the environment variable

Example:

"HUGGING_FACE_HUB_TOKEN"

templates.launch_configuration.docker_configuration.envs.value

string

required

Value of the environment variable

Example:

"hugging_face_api_token"

templates.launch_configuration.docker_configuration.port_mappings

object[]

List of port mappings between the host instance and the docker container. Equivalent of -p flag for docker run command.

Show child attributes

templates.launch_configuration.docker_configuration.port_mappings.host_port

integer

required

Port of the host.

Example:

80

templates.launch_configuration.docker_configuration.port_mappings.container_port

integer

required

Port of the container.

Example:

8000

templates.launch_configuration.docker_configuration.volume_mounts

object[]

List of volume mounts between the host instance and the docker container. Equivalent of -v flag for docker run command.

Show child attributes

templates.launch_configuration.docker_configuration.volume_mounts.host_path

string

required

Filepath of the host.

Example:

"~/.cache/huggingface"

templates.launch_configuration.docker_configuration.volume_mounts.container_path

string

required

Filepath of the container.

Example:

"/root/.cache/huggingface"

templates.launch_configuration.docker_configuration.registry_credentials

object

Show child attributes

templates.launch_configuration.docker_configuration.registry_credentials.username

string

The username for the docker registry.

Example:

"username"

templates.launch_configuration.docker_configuration.registry_credentials.password

string

The password for the docker registry.

Example:

"password"

templates.launch_configuration.script_configuration

object

May only be used if launch_configuration.type is 'script'. Configures a startup script to be run automatically after the instance is active. See this [tutorial]/guides/startupscript) for examples.

Show child attributes

templates.launch_configuration.script_configuration.base64_script

string

required

A startup script that is base64 encoded.

Example:

"IyEvYmluL2Jhc2gKCiMgRW5kbGVzcyBsb29wCndoaWxlIHRydWUKZG8KICAgICMgRmV0Y2ggYSBjYXQgZmFjdCB3aXRoIGEgbWF4aW11bSBsZW5ndGggb2YgMTQwIGNoYXJhY3RlcnMKICAgIGN1cmwgLS1uby1wcm9ncmVzcy1tZXRlciBodHRwczovL2NhdGZhY3QubmluamEvZmFjdD9tYXhfbGVuZ3RoPTE0MAoKICAgICMgUHJpbnQgYSBuZXdsaW5lIGZvciByZWFkYWJpbGl0eQogICAgZWNobwoKICAgICMgU2xlZXAgZm9yIDMgc2Vjb25kcyBiZWZvcmUgdGhlIG5leHQgaXRlcmF0aW9uCiAgICBzbGVlcCAzCmRvbmUKCgo="

templates.auto_delete

object

Set a date or spend threshold to automatically delete the instance

Show child attributes

templates.auto_delete.date_threshold

string

RFC3339 date string

Example:

"2006-01-02T15:04:05-07:00"

templates.auto_delete.spend_threshold

string

Valid decimal representation of a dollar amount

Example:

"3.14"

templates.alert

object

Set a date or spend threshold to receive an email alert

Show child attributes

templates.alert.date_threshold

string

RFC3339 date string

Example:

"2006-01-02T15:04:05-07:00"

templates.alert.spend_threshold

string

Valid decimal representation of a dollar amount

Example:

"3.14"

templates.volume_mount

object

Settings for mounting volumes onto file systems

Show child attributes

templates.volume_mount.auto

boolean

Set to true to automatically mount unmounted disks to a default filesystem.

templates.tags

string[]

Add custom, searchable tags to instances.

Tag for searching and grouping

templates.envs

object[]

List of environment variable name and values to automatically add to the instance

Show child attributes

templates.envs.name

string

required

Name of the environment variable

Example:

"HUGGING_FACE_HUB_TOKEN"

templates.envs.value

string

required

Value of the environment variable

Example:

"hugging_face_api_token"

templates.networking

object

Network and firewall configuration

Show child attributes

templates.networking.ufw_rules

object[]

List of UFW (Uncomplicated Firewall) rules

Show child attributes

templates.networking.ufw_rules.rule

string

The UFW rule action

Example:

"allow"

templates.networking.ufw_rules.from_ip

string | null

Source IP address or CIDR range

Example:

"192.168.1.0/24"

templates.networking.ufw_rules.to_ip

string | null

Destination IP address or CIDR range

Example:

"10.0.0.0/8"

templates.networking.ufw_rules.port

string | null

Port number or range (e.g. '80' or '8000:8999')

Example:

"80"

templates.networking.ufw_rules.proto

string | null

Protocol (e.g. tcp, udp)

Example:

"tcp"

/templates/{template_id}/info /templates/save

⌘I

Instances

SSH Keys

Volumes

Templates

API Documentation

/templates/featured

Authorizations

Response