# Nscale

## Docs

- [Get Base Model](https://docs.nscale.com/api-reference/basemodel/get-base-model.md): Retrieves the base model with the given ID.
- [List Base Models](https://docs.nscale.com/api-reference/basemodel/list-base-models.md): Returns a list of BaseModels.
- [Create Dataset](https://docs.nscale.com/api-reference/dataset/create-dataset.md): Creates a new fine-tuning dataset in an existing workspace.
- [Delete Dataset](https://docs.nscale.com/api-reference/dataset/delete-dataset.md): Permanently deletes a fine-tuning dataset.
- [Get Dataset](https://docs.nscale.com/api-reference/dataset/get-dataset.md): Retrieves the fine-tuning dataset with the given ID.
- [List Datasets](https://docs.nscale.com/api-reference/dataset/list-datasets.md): Returns a list of Datasets.
- [Patch apiv1organizations datasets](https://docs.nscale.com/api-reference/dataset/patch-apiv1organizations-datasets.md): Updates the specific fine-tuning dataset by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
- [List file storage classes](https://docs.nscale.com/api-reference/file-storage-classes/list-file-storage-classes.md): List storage classes.
- [Create file storage](https://docs.nscale.com/api-reference/file-storage/create-file-storage.md): Create a new storage.
- [Delete file storage](https://docs.nscale.com/api-reference/file-storage/delete-file-storage.md): Delete a storage.
- [Get file storage](https://docs.nscale.com/api-reference/file-storage/get-file-storage.md): Get all storage information this ID.
- [List file storage](https://docs.nscale.com/api-reference/file-storage/list-file-storage.md): List storage for project.
- [Update file storage](https://docs.nscale.com/api-reference/file-storage/update-file-storage.md): Update this storage.
- [Delete File](https://docs.nscale.com/api-reference/file/delete-file.md): Permanently deletes a fine-tuning data file.
- [Get File](https://docs.nscale.com/api-reference/file/get-file.md): Retrieves the fine-tuning data file with the given ID.
- [Upload File](https://docs.nscale.com/api-reference/file/upload-file.md): To upload a fine-tuning data file to Nscale, you'll need to send a request of type `multipart/form-data`. The request should contain the file you would like to upload.
- [List flavors](https://docs.nscale.com/api-reference/flavors/list-flavors.md): Lists all compute compatible flavors that the user has access to.
- [Create group](https://docs.nscale.com/api-reference/groups/create-group.md): Allows creation of a new group.
- [Delete group](https://docs.nscale.com/api-reference/groups/delete-group.md): Allows the deletion of an existing group.
- [Get group](https://docs.nscale.com/api-reference/groups/get-group.md): Allows a single group to be polled.
- [List groups](https://docs.nscale.com/api-reference/groups/list-groups.md): Returns a list of groups that are defined for the organization.
- [Update group](https://docs.nscale.com/api-reference/groups/update-group.md): Allows a group to be updated.
- [Create a compute image from a disk image URL.](https://docs.nscale.com/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.com/api-reference/images/delete-a-compute-image.md)
- [List images](https://docs.nscale.com/api-reference/images/list-images.md): Lists all compute compatible images that the user has access to.
- [Create chat completion](https://docs.nscale.com/api-reference/inference/create-chat-completion.md): Generates a chat completion response for the provided model and chat history.
- [Create completion](https://docs.nscale.com/api-reference/inference/create-completion.md): Generates a completion response for the provided model and prompt.
- [Create embeddings](https://docs.nscale.com/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.com/api-reference/inference/create-image.md): Creates an image based on the provided text prompt.
- [Create instance](https://docs.nscale.com/api-reference/instances/create-instance.md): Create an instance.
- [Delete instance](https://docs.nscale.com/api-reference/instances/delete-instance.md): Delete an instance.
- [Get instance](https://docs.nscale.com/api-reference/instances/get-instance.md): Get an instance.
- [Get instance console output](https://docs.nscale.com/api-reference/instances/get-instance-console-output.md): Get the console output for an instance.
- [Get instance console VNC](https://docs.nscale.com/api-reference/instances/get-instance-console-vnc.md): Create a new console session for an instance.
- [Get instance SSH key](https://docs.nscale.com/api-reference/instances/get-instance-ssh-key.md): Retrieve the SSH key for an instance.
- [List instances](https://docs.nscale.com/api-reference/instances/list-instances.md): List compute instances.
- [Reboot instance](https://docs.nscale.com/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.com/api-reference/instances/snapshot-instance.md): Take a snapshot of an instance and create an image from it.
- [Start instance](https://docs.nscale.com/api-reference/instances/start-instance.md): Start a stopped instance.
- [Stop instance](https://docs.nscale.com/api-reference/instances/stop-instance.md): Stop a running instnace.
- [Update instance](https://docs.nscale.com/api-reference/instances/update-instance.md): Update an instance.
- [Cancel Job](https://docs.nscale.com/api-reference/job/cancel-job.md): Cancels a fine-tuning job.
- [Create Hugging Face Export](https://docs.nscale.com/api-reference/job/create-hugging-face-export.md): Creates a new Hugging Face export for the given job.
- [Create Job](https://docs.nscale.com/api-reference/job/create-job.md): Creates a new fine-tuning job in an existing workspace.
- [Delete Job](https://docs.nscale.com/api-reference/job/delete-job.md): Deletes a fine-tuning job.
- [Download Fine-Tuned Model](https://docs.nscale.com/api-reference/job/download-fine-tuned-model.md): Downloads the settings and weights of the fine-tuned model as a `.tar.gz` archive for the given ID.
- [Get Job](https://docs.nscale.com/api-reference/job/get-job.md): Retrieves the fine-tuning job with the given ID.
- [Get Job Export](https://docs.nscale.com/api-reference/job/get-job-export.md): Retrieves the fine-tuning job export with the given ID.
- [Get Job Metrics](https://docs.nscale.com/api-reference/job/get-job-metrics.md): Retrieves the fine-tuning job metrics.
- [List Job Exports](https://docs.nscale.com/api-reference/job/list-job-exports.md): Returns a list of Job Exports for the given job.
- [List Jobs](https://docs.nscale.com/api-reference/job/list-jobs.md): Returns a list of Jobs.
- [Prepare Fine-Tuned Model Download](https://docs.nscale.com/api-reference/job/prepare-fine-tuned-model-download.md): Prepares the download of the settings and model weights for the specified fine-tuning job and redirects the client to the actual download URL once ready.
- [Update Job](https://docs.nscale.com/api-reference/job/update-job.md): Updates the specific fine-tuning job by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
- [List endpoints](https://docs.nscale.com/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.com/api-reference/models/list-models.md): Returns a list of models available for the specified organization.
- [Create network](https://docs.nscale.com/api-reference/networks/create-network.md): Create a new network.
- [Delete network](https://docs.nscale.com/api-reference/networks/delete-network.md): Delete a network.
- [Get network](https://docs.nscale.com/api-reference/networks/get-network.md): Get a network.
- [List networks](https://docs.nscale.com/api-reference/networks/list-networks.md): List networks.
- [Update network](https://docs.nscale.com/api-reference/networks/update-network.md): Update a network.
- [Get organization](https://docs.nscale.com/api-reference/organizations/get-organization.md): Get an organization.
- [List organizations](https://docs.nscale.com/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.com/api-reference/organizations/update-organization.md): Update an organization.
- [Create project](https://docs.nscale.com/api-reference/projects/create-project.md): Creates a new project resource for the user's organization.
- [Delete project](https://docs.nscale.com/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.com/api-reference/projects/get-project.md): Gets a project.
- [List projects](https://docs.nscale.com/api-reference/projects/list-projects.md): List all projects for the organization.
- [Update project](https://docs.nscale.com/api-reference/projects/update-project.md): Updates a project.
- [List quotas](https://docs.nscale.com/api-reference/quotas/list-quotas.md): Gets quotas for the organization.
- [List regions](https://docs.nscale.com/api-reference/regions/list-regions.md): Lists compute service compatible regions.
- [List roles](https://docs.nscale.com/api-reference/roles/list-roles.md): Returns roles that can be used by the organization.
- [Create security group](https://docs.nscale.com/api-reference/security-groups/create-security-group.md): Create a new security group.
- [Delete security group](https://docs.nscale.com/api-reference/security-groups/delete-security-group.md): Delete a security groups.
- [Get security group](https://docs.nscale.com/api-reference/security-groups/get-security-group.md): Get a security group.
- [List security groups](https://docs.nscale.com/api-reference/security-groups/list-security-groups.md): List security groups.
- [Update security group](https://docs.nscale.com/api-reference/security-groups/update-security-group.md): Update a security group.
- [Create service account](https://docs.nscale.com/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.com/api-reference/service-accounts/delete-service-account.md): Removes a service account and revokes an access token.
- [List service accounts](https://docs.nscale.com/api-reference/service-accounts/list-service-accounts.md): Lists all service accounts.
- [Rotate service account token](https://docs.nscale.com/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.com/api-reference/service-accounts/update-service-account.md): Updates a service account.
- [Create user](https://docs.nscale.com/api-reference/users/create-user.md): Creates a new user and associates with a set of groups.
- [Delete user](https://docs.nscale.com/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.com/api-reference/users/list-users.md): Lists all users.
- [Update user](https://docs.nscale.com/api-reference/users/update-user.md): Updates a user.
- [Changelog](https://docs.nscale.com/changelog/changelog.md): News and improvements from the Nscale team.
- [Datasets ](https://docs.nscale.com/docs/ai-services/datasets.md): This guide will walk you through the creation, management, and deletion of datasets for fine-tuning of foundational language models.
- [Evaluations (coming soon)](https://docs.nscale.com/docs/ai-services/evaluations.md): Coming soon
- [Fine Tuning ](https://docs.nscale.com/docs/ai-services/fine-tuning.md): This guide will walk you through the creation, management, and monitoring of fine-tuning jobs.
- [Overview](https://docs.nscale.com/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.com/docs/ai-services/workbench.md): Experiment with models, save and compare presets, and view costs.
- [Contexts](https://docs.nscale.com/docs/cli/contexts.md): Manage CLI contexts to switch between organizations and user configurations.
- [Device Authorization](https://docs.nscale.com/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.com/docs/cli/filestorage.md): Manage file storage resources.
- [Flavors](https://docs.nscale.com/docs/cli/flavors.md): List available compute flavors (instance types).
- [Groups](https://docs.nscale.com/docs/cli/groups.md): Manage groups within an organization.
- [Images](https://docs.nscale.com/docs/cli/images.md): Manage compute images.
- [Inferencing](https://docs.nscale.com/docs/cli/inferencing.md): Manage inferencing resources — list models, endpoints, and send chat completions.
- [Instances](https://docs.nscale.com/docs/cli/instances.md): Manage compute instances.
- [Login](https://docs.nscale.com/docs/cli/login.md): Authenticate with Nscale using browser-based device authorization.
- [Logout](https://docs.nscale.com/docs/cli/logout.md): Log out of the CLI and remove stored credentials.
- [Networks](https://docs.nscale.com/docs/cli/networks.md): Manage VPC networks.
- [Organizations](https://docs.nscale.com/docs/cli/organizations.md): List organizations your account has access to.
- [Overview](https://docs.nscale.com/docs/cli/overview.md): The CLI provides a powerful, automation-friendly interface to all Nscale resources and services.
- [Projects](https://docs.nscale.com/docs/cli/projects.md): Manage projects within an organization.
- [Query output with -q](https://docs.nscale.com/docs/cli/query-output.md): Use jq filters to extract or reshape JSON responses without a second process.
- [Regions](https://docs.nscale.com/docs/cli/regions.md): List available Nscale regions.
- [Security groups](https://docs.nscale.com/docs/cli/securitygroups.md): Manage security groups for controlling network access to instances.
- [Service accounts](https://docs.nscale.com/docs/cli/serviceaccounts.md): Manage service accounts and their access tokens.
- [SSH certificate authorities](https://docs.nscale.com/docs/cli/ssh-cas.md): Manage SSH certificate authorities used to sign instance SSH host keys.
- [Version](https://docs.nscale.com/docs/cli/version.md): Display the current version of the CLI.
- [Clusters](https://docs.nscale.com/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.com/docs/compute/create-new-instances.md)
- [arXiv Multimodal RAG](https://docs.nscale.com/docs/cookbooks/arXiv-Multimodal-RAG.md)
- [Fine-tuning PubMedQA](https://docs.nscale.com/docs/cookbooks/pubmedqa-fine-tuning.md): Convert a sub-set of [PubMedQA](https://huggingface.co/datasets/qiaojin/PubMedQA) dataset to the required CSV format, upload as a dataset, then create and monitor a fine-tuning job on Nscale.
- [Deprecations](https://docs.nscale.com/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.com/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.com/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.com/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.com/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.com/docs/help/contact-support.md): Learn how to get technical assistance from Nscale Support
- [Service Level Objectives](https://docs.nscale.com/docs/help/service-level-objectives.md): Nscale Technical Support Service Level Objectives
- [Shared Responsibility Model](https://docs.nscale.com/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.com/docs/help/terms.md)
- [Credit](https://docs.nscale.com/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.com/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.com/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.com/docs/manage/reporting-an-incident.md)
- [Service tokens](https://docs.nscale.com/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.com/docs/manage/terraform.md)
- [Security Groups](https://docs.nscale.com/docs/network/security-groups.md)
- [VPC Networks](https://docs.nscale.com/docs/network/vpc-networks.md)
- [Custom Images](https://docs.nscale.com/docs/storage/custom-images.md)
- [Filesystem](https://docs.nscale.com/docs/storage/file-storage.md)
- [Snapshots](https://docs.nscale.com/docs/storage/snapshots.md)
- [Chat](https://docs.nscale.com/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.com/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.