# Nscale

## Docs

- [List file storage classes](https://docs.nscale.tech/api-reference/file-storage-classes/list-file-storage-classes.md): List storage classes.
- [Create file storage](https://docs.nscale.tech/api-reference/file-storage/create-file-storage.md): Create a new storage. Snapshot Policies are managed as inline parent File Storage desired state. Omitted or empty spec.snapshotPolicies stores no user-managed policies, and a non-empty list persists exactly the caller-supplied policies. Default Snapshot Protection is controlled separately by spec.de…
- [Delete file storage](https://docs.nscale.tech/api-reference/file-storage/delete-file-storage.md): Delete a storage.
- [Get file storage](https://docs.nscale.tech/api-reference/file-storage/get-file-storage.md): Get all storage information this ID.
- [List file storage](https://docs.nscale.tech/api-reference/file-storage/list-file-storage.md): List storage for project.
- [Update file storage](https://docs.nscale.tech/api-reference/file-storage/update-file-storage.md): Update this storage. Snapshot Policies are managed as inline parent File Storage desired state. Omitted spec.snapshotPolicies preserves existing user-managed policies, an empty list clears all user-managed policies, and a non-empty list replaces the full user-managed policy list. Default Snapshot Pr…
- [List flavors](https://docs.nscale.tech/api-reference/flavors/list-flavors.md): Lists all compute compatible flavors that the user has access to.
- [Create group](https://docs.nscale.tech/api-reference/groups/create-group.md): Allows creation of a new group.
- [Delete group](https://docs.nscale.tech/api-reference/groups/delete-group.md): Allows the deletion of an existing group.
- [Get group](https://docs.nscale.tech/api-reference/groups/get-group.md): Allows a single group to be polled.
- [List groups](https://docs.nscale.tech/api-reference/groups/list-groups.md): Returns a list of groups that are defined for the organization.
- [Update group](https://docs.nscale.tech/api-reference/groups/update-group.md): Allows a group to be updated.
- [Create a compute image from a disk image URL.](https://docs.nscale.tech/api-reference/images/create-a-compute-image-from-a-disk-image-url.md): Create a compute image from a public URL.  Only raw images are supported, other container formats such as qcow2 must be first converted to a raw image.
- [Delete a compute image.](https://docs.nscale.tech/api-reference/images/delete-a-compute-image.md)
- [List compute disk images](https://docs.nscale.tech/api-reference/images/list-compute-disk-images.md)
- [List images](https://docs.nscale.tech/api-reference/images/list-images.md): Lists all compute compatible images that the user has access to.
- [Create chat completion](https://docs.nscale.tech/api-reference/inference/create-chat-completion.md): Generates a chat completion response for the provided model and chat history.
- [Create completion](https://docs.nscale.tech/api-reference/inference/create-completion.md): Generates a completion response for the provided model and prompt.
- [Create embeddings](https://docs.nscale.tech/api-reference/inference/create-embeddings.md): Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.
- [Create image](https://docs.nscale.tech/api-reference/inference/create-image.md): Creates an image based on the provided text prompt.
- [Create instance](https://docs.nscale.tech/api-reference/instances/create-instance.md): Create an instance.
- [Delete instance](https://docs.nscale.tech/api-reference/instances/delete-instance.md): Delete an instance.
- [Get instance](https://docs.nscale.tech/api-reference/instances/get-instance.md): Get an instance.
- [Get instance console output](https://docs.nscale.tech/api-reference/instances/get-instance-console-output.md): Get the console output for an instance.
- [Get instance console VNC](https://docs.nscale.tech/api-reference/instances/get-instance-console-vnc.md): Create a new console session for an instance.
- [Get instance SSH key](https://docs.nscale.tech/api-reference/instances/get-instance-ssh-key.md): Retrieve the SSH key for an instance.
- [List instances](https://docs.nscale.tech/api-reference/instances/list-instances.md): List compute instances.
- [Reboot instance](https://docs.nscale.tech/api-reference/instances/reboot-instance.md): Reboot an instance.  By default this will perform a software ACPI reboot. You can specifiy a hard power cycle as a query parameter.
- [Snapshot instance](https://docs.nscale.tech/api-reference/instances/snapshot-instance.md): Take a snapshot of an instance and create an image from it.
- [Start instance](https://docs.nscale.tech/api-reference/instances/start-instance.md): Start a stopped instance.
- [Stop instance](https://docs.nscale.tech/api-reference/instances/stop-instance.md): Stop a running instnace.
- [Update instance](https://docs.nscale.tech/api-reference/instances/update-instance.md): Update an instance.
- [Create load balancer](https://docs.nscale.tech/api-reference/load-balancers/create-load-balancer.md): Create a new load balancer.
- [Delete load balancer](https://docs.nscale.tech/api-reference/load-balancers/delete-load-balancer.md): Delete a load balancer.
- [Get load balancer](https://docs.nscale.tech/api-reference/load-balancers/get-load-balancer.md): Get a load balancer.
- [List load balancers](https://docs.nscale.tech/api-reference/load-balancers/list-load-balancers.md): List load balancers.
- [Update load balancer](https://docs.nscale.tech/api-reference/load-balancers/update-load-balancer.md): Update a load balancer.
- [List endpoints](https://docs.nscale.tech/api-reference/models/list-endpoints.md): Returns a list of all model endpoints that are available for use by the specified organization. Includes details like pricing as decimal USD, model information, and last usage.
- [List models](https://docs.nscale.tech/api-reference/models/list-models.md): Returns a list of models available for the specified organization.
- [Create network](https://docs.nscale.tech/api-reference/networks/create-network.md): Create a new network.
- [Delete network](https://docs.nscale.tech/api-reference/networks/delete-network.md): Delete a network.
- [Get network](https://docs.nscale.tech/api-reference/networks/get-network.md): Get a network.
- [List networks](https://docs.nscale.tech/api-reference/networks/list-networks.md): List networks.
- [Update network](https://docs.nscale.tech/api-reference/networks/update-network.md): Update a network's mutable fields.
- [Create endpoint](https://docs.nscale.tech/api-reference/object-storage/create-endpoint.md): Provisions a new S3-compatible object storage endpoint in the requested organization, project, and region using the selected immutable endpoint class. Access keys are managed through dedicated APIs, and identity policies are managed as part of the endpoint specification.
- [Create endpoint access key](https://docs.nscale.tech/api-reference/object-storage/create-endpoint-access-key.md): Creates an access key for the specified object storage endpoint. The server generates the immutable access key identifier and secret. The secret is returned only once in the create response.
- [Delete endpoint](https://docs.nscale.tech/api-reference/object-storage/delete-endpoint.md): Deletes the object storage endpoint and any endpoint-level resources managed with it (including any buckets created through the endpoint).
- [Delete endpoint access key](https://docs.nscale.tech/api-reference/object-storage/delete-endpoint-access-key.md): Deletes the specified access key associated with the specified object storage endpoint.
- [Get endpoint](https://docs.nscale.tech/api-reference/object-storage/get-endpoint.md): Returns a single object storage endpoint, including its class selection, configured identity policies, and any exposure details that have been provisioned.
- [Get endpoint access key](https://docs.nscale.tech/api-reference/object-storage/get-endpoint-access-key.md): Returns the specified access key associated with the specified object storage endpoint. The response includes the access key identifier and identity policy name, but never the secret.
- [List endpoint access keys](https://docs.nscale.tech/api-reference/object-storage/list-endpoint-access-keys.md): Returns the access keys associated with the specified object storage endpoint. Each access key includes only its identity policy name and access key identifier.
- [List endpoint classes](https://docs.nscale.tech/api-reference/object-storage/list-endpoint-classes.md): List the available object storage endpoint classes, including supported exposure types and regional availability.
- [List endpoints](https://docs.nscale.tech/api-reference/object-storage/list-endpoints.md): List the object storage endpoints with optional filtering by tag, organization, project, and region.
- [Update endpoint](https://docs.nscale.tech/api-reference/object-storage/update-endpoint.md): Updates the endpoint metadata and, optionally, replaces the full set of configured identity policies. The selected endpoint class remains immutable after creation.
- [Get organization](https://docs.nscale.tech/api-reference/organizations/get-organization.md): Get an organization.
- [List organizations](https://docs.nscale.tech/api-reference/organizations/list-organizations.md): Returns a list of organizations that the user is a member of.  If an email address is provided in the query this allows a user with sufficient privilege to check if a given user is a member of any organizations.
- [Update organization](https://docs.nscale.tech/api-reference/organizations/update-organization.md): Update an organization.
- [Get placement server](https://docs.nscale.tech/api-reference/placement-servers/get-placement-server.md): Get a placement server.
- [List placement servers](https://docs.nscale.tech/api-reference/placement-servers/list-placement-servers.md): List placement servers.
- [Reboot placement server](https://docs.nscale.tech/api-reference/placement-servers/reboot-placement-server.md): Reboot a placement server.
- [Stop placement server](https://docs.nscale.tech/api-reference/placement-servers/stop-placement-server.md): Stop a placement server.
- [Create placement](https://docs.nscale.tech/api-reference/placements/create-placement.md): Create a placement.
- [Delete placement](https://docs.nscale.tech/api-reference/placements/delete-placement.md): Delete a placement and all Region servers created for it.
- [Get placement](https://docs.nscale.tech/api-reference/placements/get-placement.md): Get a placement.
- [List placements](https://docs.nscale.tech/api-reference/placements/list-placements.md): List placements.
- [Create project](https://docs.nscale.tech/api-reference/projects/create-project.md): Creates a new project resource for the user's organization.
- [Delete project](https://docs.nscale.tech/api-reference/projects/delete-project.md): Deletes the project associated with the authenticated user's scoped authorization token. This is a cascading operation and will delete all contained cluster managers and clusters.
- [Get project](https://docs.nscale.tech/api-reference/projects/get-project.md): Gets a project.
- [List projects](https://docs.nscale.tech/api-reference/projects/list-projects.md): List all projects for the organization.
- [Update project](https://docs.nscale.tech/api-reference/projects/update-project.md): Updates a project.
- [List quotas](https://docs.nscale.tech/api-reference/quotas/list-quotas.md): Gets quotas for the organization.
- [List regions](https://docs.nscale.tech/api-reference/regions/list-regions.md): Lists compute service compatible regions.
- [List reservation units](https://docs.nscale.tech/api-reference/reservation-units/list-reservation-units.md): List reservation units.
- [Create reservation](https://docs.nscale.tech/api-reference/reservations/create-reservation.md): Create a reservation.
- [Delete reservation](https://docs.nscale.tech/api-reference/reservations/delete-reservation.md): Delete a reservation and all placements allocated from it.
- [Get reservation](https://docs.nscale.tech/api-reference/reservations/get-reservation.md): Get a reservation.
- [List reservations](https://docs.nscale.tech/api-reference/reservations/list-reservations.md): List reservations.
- [List roles](https://docs.nscale.tech/api-reference/roles/list-roles.md): Returns roles that can be used by the organization.
- [Create security group](https://docs.nscale.tech/api-reference/security-groups/create-security-group.md): Create a new security group.
- [Delete security group](https://docs.nscale.tech/api-reference/security-groups/delete-security-group.md): Delete a security groups.
- [Get security group](https://docs.nscale.tech/api-reference/security-groups/get-security-group.md): Get a security group.
- [List security groups](https://docs.nscale.tech/api-reference/security-groups/list-security-groups.md): List security groups.
- [Update security group](https://docs.nscale.tech/api-reference/security-groups/update-security-group.md): Update a security group.
- [Create service account](https://docs.nscale.tech/api-reference/service-accounts/create-service-account.md): Creates a new service account and returns an access token,  The returned access token can only be read once.
- [Delete service account](https://docs.nscale.tech/api-reference/service-accounts/delete-service-account.md): Removes a service account and revokes an access token.
- [List service accounts](https://docs.nscale.tech/api-reference/service-accounts/list-service-accounts.md): Lists all service accounts.
- [Rotate service account token](https://docs.nscale.tech/api-reference/service-accounts/rotate-service-account-token.md): Rotates a service account's access token. The returned access token can only be read once.
- [Update service account](https://docs.nscale.tech/api-reference/service-accounts/update-service-account.md): Updates a service account.
- [Create SSH certificate authority](https://docs.nscale.tech/api-reference/ssh-certificate-authorities/create-ssh-certificate-authority.md): Create a new SSH certificate authority.
- [Delete SSH certificate authority](https://docs.nscale.tech/api-reference/ssh-certificate-authorities/delete-ssh-certificate-authority.md): Delete an SSH certificate authority.
- [Get SSH certificate authority](https://docs.nscale.tech/api-reference/ssh-certificate-authorities/get-ssh-certificate-authority.md): Get an SSH certificate authority.
- [List SSH certificate authorities](https://docs.nscale.tech/api-reference/ssh-certificate-authorities/list-ssh-certificate-authorities.md): List SSH certificate authorities.
- [Create user](https://docs.nscale.tech/api-reference/users/create-user.md): Creates a new user and associates with a set of groups.
- [Delete user](https://docs.nscale.tech/api-reference/users/delete-user.md): Deletes a user and disassociates them with all groups they are a member of.
- [List users](https://docs.nscale.tech/api-reference/users/list-users.md): Lists all users.
- [Update user](https://docs.nscale.tech/api-reference/users/update-user.md): Updates a user.
- [Get the deployed service version](https://docs.nscale.tech/api-reference/version/get-the-deployed-service-version.md): Returns the build version stamped into the running binary at release time, allowing clients and CI gates to verify exactly which release is deployed.
- [Changelog](https://docs.nscale.tech/changelog/changelog.md): News and improvements from the Nscale team.
- [Evaluations (coming soon)](https://docs.nscale.tech/docs/ai-services/evaluations.md): Coming soon
- [Overview](https://docs.nscale.tech/docs/ai-services/models.md): Explore the models currently available for serverless inference, ready to deploy instantly for chat, vision, embeddings and image generation.
- [Workbench](https://docs.nscale.tech/docs/ai-services/workbench.md): Experiment with models, save and compare presets, and view costs.
- [Contexts](https://docs.nscale.tech/docs/cli/contexts.md): Manage CLI contexts to switch between organizations and user configurations.
- [Device authorization](https://docs.nscale.tech/docs/cli/device-authorization.md): Reference for the OAuth 2.0 device authorization grant flow used by the CLI, including endpoints, timing, and security notes.
- [File storage](https://docs.nscale.tech/docs/cli/filestorage.md): Manage file storage resources.
- [Flavors](https://docs.nscale.tech/docs/cli/flavors.md): List available compute flavors (instance types).
- [Groups](https://docs.nscale.tech/docs/cli/groups.md): Manage groups within an organization.
- [Images](https://docs.nscale.tech/docs/cli/images.md): Manage compute images.
- [Inferencing](https://docs.nscale.tech/docs/cli/inferencing.md): Manage inferencing resources — list models, endpoints, and send chat completions.
- [Instances](https://docs.nscale.tech/docs/cli/instances.md): Manage compute instances.
- [Login](https://docs.nscale.tech/docs/cli/login.md): Authenticate with Nscale using browser-based device authorization.
- [Logout](https://docs.nscale.tech/docs/cli/logout.md): Log out of the CLI and remove stored credentials.
- [Networks](https://docs.nscale.tech/docs/cli/networks.md): Manage VPC networks.
- [Object storage](https://docs.nscale.tech/docs/cli/object-storage.md): Manage object storage endpoints, identity policies, and access keys.
- [Organizations](https://docs.nscale.tech/docs/cli/organizations.md): List organizations your account has access to.
- [Overview](https://docs.nscale.tech/docs/cli/overview.md): The CLI provides a powerful, automation-friendly interface to all Nscale resources and services.
- [Placements](https://docs.nscale.tech/docs/cli/placements.md): Manage GPU placements.
- [Projects](https://docs.nscale.tech/docs/cli/projects.md): Manage projects within an organization.
- [Query output with -q](https://docs.nscale.tech/docs/cli/query-output.md): Use jq filters to extract or reshape JSON responses without a second process.
- [Regions](https://docs.nscale.tech/docs/cli/regions.md): List available Nscale regions.
- [Reservations](https://docs.nscale.tech/docs/cli/reservations.md): Manage GPU reservations.
- [Security groups](https://docs.nscale.tech/docs/cli/securitygroups.md): Manage security groups for controlling network access to instances.
- [Service accounts](https://docs.nscale.tech/docs/cli/serviceaccounts.md): Manage service accounts and their access tokens.
- [SSH certificate authorities](https://docs.nscale.tech/docs/cli/ssh-cas.md): Manage SSH certificate authorities used to sign instance SSH host keys.
- [Version](https://docs.nscale.tech/docs/cli/version.md): Display the current version of the CLI.
- [Clusters](https://docs.nscale.tech/docs/compute/clusters.md): This guide provides step-by-step instructions to help users create, manage, and monitor virtual machines within the Clusters. It covers how to select VM configurations, choose system images, connect to project-level networks, and perform lifecycle actions. The guide is designed to support new users…
- [Instances](https://docs.nscale.tech/docs/compute/create-new-instances.md)
- [Placements](https://docs.nscale.tech/docs/compute/placements.md): Schedule bare-metal GB300 servers inside a reservation using a Pack or Spread topology policy.
- [Reservations](https://docs.nscale.tech/docs/compute/reservations.md): Reserve exclusive, topology-aware GB300 NVL72 GPU capacity for a project, then launch workloads onto it with placements.
- [SSH certificate authorities](https://docs.nscale.tech/docs/compute/ssh-certificate-authorities.md): Register an SSH certificate authority to authenticate users to your instances with signed certificates instead of individual SSH keys.
- [arXiv Multimodal RAG](https://docs.nscale.tech/docs/cookbooks/arXiv-Multimodal-RAG.md)
- [Deprecations](https://docs.nscale.tech/docs/faqs/deprecations.md): We’re excited to keep our platform at the cutting edge with robust open-source model upgrades.
- [Error codes](https://docs.nscale.tech/docs/faqs/error-codes.md): Refer to the error codes below for troubleshooting common issues with Nscale's serverless inference service.
- [Rate Limits](https://docs.nscale.tech/docs/faqs/rate-limits.md): Rate limits define the maximum number of requests a user can make to Nscale’s serverless inference service within a given time frame.
- [Overview](https://docs.nscale.tech/docs/getting-started/overview.md): Welcome to the Nscale docs. Discover how to get started and unlock the full potential of Nscale.
- [Quickstart](https://docs.nscale.tech/docs/getting-started/quickstart.md): Get up and running with Nscale’s serverless inference models in just a few steps. This guide will walk you through signing up, adding credit to your account, and making your first API call to start leveraging the power of our AI models.
- [How to Contact Support](https://docs.nscale.tech/docs/help/contact-support.md): Learn how to get technical assistance from Nscale Support
- [Logs for troubleshooting](https://docs.nscale.tech/docs/help/logs-for-troubleshooting.md): Manual log collection expectations for NVIDIA GPU infrastructure support cases.
- [Service Level Objectives](https://docs.nscale.tech/docs/help/service-level-objectives.md): Nscale Technical Support Service Level Objectives
- [Shared Responsibility Model](https://docs.nscale.tech/docs/help/shared-responsibility.md): How responsibility for security, privacy, and operations is divided between you and Nscale across our AI Services.
- [Terms](https://docs.nscale.tech/docs/help/terms.md)
- [Credit](https://docs.nscale.tech/docs/manage/credit.md): Nscale AI services use a credit-based billing system. To access AI services, you’ll need to purchase credits, which are deducted as you consume resources. You can monitor your balance, usage, and transaction history in the Usage & Billing section.
- [Monitoring usage](https://docs.nscale.tech/docs/manage/monitoring-usage.md): You can monitor your usage and spend in the Usage & Billing section to manage costs, optimise workloads, and prevent unexpected credit depletion.
- [Projects](https://docs.nscale.tech/docs/manage/projects.md): Understand how projects group and isolate your resources across Nscale services.
- [Reporting Nvidia GPU Instance Errors to Nscale Support](https://docs.nscale.tech/docs/manage/reporting-an-incident.md)
- [Groups and roles](https://docs.nscale.tech/docs/manage/roles-and-groups.md): Control who can access your organization and what they can do, using groups, roles, and project scoping.
- [Service tokens](https://docs.nscale.tech/docs/manage/service-tokens.md): Service Tokens (JWTs) provide scoped, time‑limited access for non‑human clients (e.g. backend services, cron jobs). Each token is a signed JSON Web Token that your services can present to authenticate against the Nscale API.
- [Terraform Provider](https://docs.nscale.tech/docs/manage/terraform.md)
- [Security groups](https://docs.nscale.tech/docs/network/security-groups.md)
- [VPC Networks](https://docs.nscale.tech/docs/network/vpc-networks.md)
- [Custom Images](https://docs.nscale.tech/docs/storage/custom-images.md)
- [Filesystem](https://docs.nscale.tech/docs/storage/file-storage.md)
- [Object Storage](https://docs.nscale.tech/docs/storage/object-storage.md)
- [Snapshots](https://docs.nscale.tech/docs/storage/snapshots.md)
- [Chat](https://docs.nscale.tech/docs/use-cases/chat.md): This guide will walk you through integrating a chat model into your application using Nscale’s API. With our serverless architecture, you can focus on building your application without worrying about infrastructure management.
- [Image Generation](https://docs.nscale.tech/docs/use-cases/image-generation.md): This guide will walk you through integrating image generation models into your application using Nscale's API. With our serverless architecture, you can focus on building your application without worrying about infrastructure management.