# Shadeform Documentation

## Docs

- [Authentication](https://docs.shadeform.ai/api-reference/authentication.md): Learn how to authenticate API requests to the Shadeform API
- [/clusters](https://docs.shadeform.ai/api-reference/clusters/clusters.md): Get all non deleted clusters.
- [/clusters/create](https://docs.shadeform.ai/api-reference/clusters/clusters-create.md): Create a new GPU cluster.
- [/clusters/{id}/delete](https://docs.shadeform.ai/api-reference/clusters/clusters-delete.md): This will move the cluster to the 'deleting' status while the cluster is being deleted. Once the cluster has entered the 'deleting' status, the account will no longer be billed for the cluster.
- [/clusters/{id}/info](https://docs.shadeform.ai/api-reference/clusters/clusters-info.md): Get details for the specified, non deleted, cluster in the url.
- [/clusters/types](https://docs.shadeform.ai/api-reference/clusters/clusters-types.md): Return all the GPU cluster types with their corresponding availability and specs.
- [/instances](https://docs.shadeform.ai/api-reference/instances/instances.md): Get all non deleted instances. Note: instances in the "deleting" status will also show up here.
- [/instances/create](https://docs.shadeform.ai/api-reference/instances/instances-create.md): Create a new GPU instance. Our create API is designed to be asynchronous, so the response will be a CreateResponse object with a status of "creating". We then have a process that will pick it up and create it. You can poll the /instances/{id}/info endpoint to check the status of the instance.
- [/instances/{id}/delete](https://docs.shadeform.ai/api-reference/instances/instances-delete.md): This will move the instance to the 'deleting' status while the instance is being deleted. Once the instance has entered the 'deleting' status, the account will no longer be billed for the instance.
- [/instances/{id}/info](https://docs.shadeform.ai/api-reference/instances/instances-info.md): Get details for the specified, non deleted, instance in the url.
- [/instances/{id}/restart](https://docs.shadeform.ai/api-reference/instances/instances-restart.md): Restart an instance. The status of the instance will stay as 'active' throughout, but you may have to wait a few minutes for the instance to be ready to use again.
- [/instances/types](https://docs.shadeform.ai/api-reference/instances/instances-types.md): Return all the GPU instance types with their corresponding availability and specs.
- [/instances/{id}/update](https://docs.shadeform.ai/api-reference/instances/instances-update.md): Update mutable details about the instance. Set a value to null to delete it. Omit a value or leave undefined to keep unchanged.
- [/sshkeys](https://docs.shadeform.ai/api-reference/sshkeys/sshkeys.md): Get all SSH Keys for the account.
- [/sshkeys/add](https://docs.shadeform.ai/api-reference/sshkeys/sshkeys-add.md): Add a new SSH Key
- [/sshkeys/{id}/delete](https://docs.shadeform.ai/api-reference/sshkeys/sshkeys-delete.md): Delete an ssh key. The Shadeform managed SSH Key, current default ssh key, and in use SSH Keys cannot be deleted.
- [/sshkeys/{id}/info](https://docs.shadeform.ai/api-reference/sshkeys/sshkeys-info.md): Get details for the specified SSH Key in the url.
- [/sshkeys/{id}/setdefault](https://docs.shadeform.ai/api-reference/sshkeys/sshkeys-setdefault.md): Set the specified SSH Key as the default SSH Key used by Shadeform.
- [/templates](https://docs.shadeform.ai/api-reference/templates/templates.md): List all templates created by the user
- [/templates/{template_id}/delete](https://docs.shadeform.ai/api-reference/templates/templates-delete.md): Delete a template
- [/templates/featured](https://docs.shadeform.ai/api-reference/templates/templates-featured.md): List featured templates
- [/templates/{template_id}/info](https://docs.shadeform.ai/api-reference/templates/templates-info.md): Get information about a specific template
- [/templates/save](https://docs.shadeform.ai/api-reference/templates/templates-save.md): Create a new template
- [/templates/{template_id}/update](https://docs.shadeform.ai/api-reference/templates/templates-update.md): Update an existing template
- [/volumes](https://docs.shadeform.ai/api-reference/volumes/volumes.md): Get all storage volumes for the account.
- [/volumes/create](https://docs.shadeform.ai/api-reference/volumes/volumes-create.md): Create a new storage volume
- [/volumes/{id}/delete](https://docs.shadeform.ai/api-reference/volumes/volumes-delete.md): Delete a storage volume.
- [/volumes/{id}/info](https://docs.shadeform.ai/api-reference/volumes/volumes-info.md): Get details for the specified storage volume.
- [/volumes/types](https://docs.shadeform.ai/api-reference/volumes/volumes-types.md): Get list of supported storage volumes.
- [Core Concepts](https://docs.shadeform.ai/getting-started/concepts.md)
- [FAQ](https://docs.shadeform.ai/getting-started/faq.md)
- [Introduction](https://docs.shadeform.ai/getting-started/introduction.md)
- [Quickstart](https://docs.shadeform.ai/getting-started/quickstart.md)
- [Setup a Volume](https://docs.shadeform.ai/guides/attachvolume.md)
- [Evaluate Language Models](https://docs.shadeform.ai/guides/benchmark.md)
- [Run Docker Container](https://docs.shadeform.ai/guides/dockercontainers.md)
- [Setup Firewall Using UFW](https://docs.shadeform.ai/guides/firewall.md)
- [Run Jupyter Notebook](https://docs.shadeform.ai/guides/jupyter.md)
- [Find and Deploy the Most Affordable GPU](https://docs.shadeform.ai/guides/mostaffordablegpus.md)
- [Run Jobs with SkyPilot](https://docs.shadeform.ai/guides/skypilot.md)
- [Common SSH Issues and Solutions](https://docs.shadeform.ai/guides/sshissues.md)
- [Bring Your Own SSH Keys](https://docs.shadeform.ai/guides/sshkeys.md)
- [Run Startup Script](https://docs.shadeform.ai/guides/startupscript.md)
- [Using Templates](https://docs.shadeform.ai/guides/templates.md)
- [Tutorial Library](https://docs.shadeform.ai/guides/tutoriallibrary.md)
- [Serve Model Using vLLM](https://docs.shadeform.ai/guides/vllm.md)

## OpenAPI Specs

- [openapi](https://docs.shadeform.ai/openapi.yaml)