{"openapi":"3.0.0","info":{"description":"Vast.ai API connector — GPU cloud marketplace (instances, search/offers, volumes, serverless workergroups + endpoints, SSH keys, billing, teams). Official OpenAPI 3.1 spec (66 paths / 89 operations) at docs.vast.ai; Bearer API key; host console.vast.ai.","version":"v0"},"servers":[{"description":"Vast.ai API connector — GPU cloud marketplace (instances, search/offers, volumes, serverless workergroups + endpoints, SSH keys, billing, teams). Official OpenAPI 3.1 spec (66 paths / 89 operations) at docs.vast.ai; Bearer API key; host console.vast.ai.","url":"https://api.apirails.com/vastai"}],"paths":{"/api/v0/network_disk/":{"post":{"tags":["Network Volumes"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/volumes","api_endpoint":"https://console.vast.ai/api/v0/network_disk/"},"summary":"Add Network-Disk","description":"Adds a network disk to be used to create network volume offers, or adds machines to an existing network disk.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"disk_id":{"type":"number","description":"ID of network disk, if adding machines to existing disk"},"machine_id":{"type":"number","description":"ID of the machine to add network disk to"},"machine_ids":{"type":"array","description":"IDs of machines to add network disk to","items":{"type":"number"}},"mount_point":{"type":"string","description":"Path to mount point of networked storage on machine or machines","required":true}}},"example":{"disk_id":"","machine_id":"","machine_ids":[],"mount_point":""}}}}}},"/api/v0/instances/{id}/ssh/":{"post":{"tags":["Instances"],"parameters":[{"name":"id","in":"path","description":"ID of the instance to attach the SSH key to","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/instances","api_endpoint":"https://console.vast.ai/api/v0/instances/{id}/ssh/"},"summary":"Attach Ssh-Key","description":"Attaches an SSH key to the specified instance, allowing SSH access using the provided key.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ssh_key":{"type":"string","description":"The SSH key to attach to the instance"}}},"example":{"ssh_key":""}}}}}},"/api/v0/commands/copy_direct/":{"delete":{"tags":["Instances"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/instances","api_endpoint":"https://console.vast.ai/api/v0/commands/copy_direct/"},"summary":"Cancel Copy","description":"Cancel a remote copy operation specified by the destination ID (dst_id).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"put":{"tags":["Instances"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/instances","api_endpoint":"https://console.vast.ai/api/v0/commands/copy_direct/"},"summary":"Copy","description":"Initiate a remote copy operation to transfer data from one instance to another or between an instance and the local machine.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"dst_id":{"type":"string","description":"ID of the destination instance."},"dst_path":{"type":"string","description":"Path of the destination data.","required":true},"src_id":{"type":"string","description":"ID of the source instance."},"src_path":{"type":"string","description":"Path of the source data.","required":true}}},"example":{"dst_id":"","dst_path":"","src_id":"","src_path":""}}}}}},"/api/v0/machines/{machine_id}/cancel_maint/":{"put":{"tags":["Machines"],"parameters":[{"name":"machine_id","in":"path","description":"ID of the machine to cancel maintenance for.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/machines","api_endpoint":"https://console.vast.ai/api/v0/machines/{machine_id}/cancel_maint/"},"summary":"Cancel Maint","description":"Cancel a scheduled maintenance window for a specified machine.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/v0/commands/rclone/":{"delete":{"tags":["Instances"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/instances","api_endpoint":"https://console.vast.ai/api/v0/commands/rclone/"},"summary":"Cancel Sync","description":"Cancels an in-progress remote sync operation identified by the destination instance ID.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"post":{"tags":["Instances"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/instances","api_endpoint":"https://console.vast.ai/api/v0/commands/rclone/"},"summary":"Cloud Copy","description":"Starts a cloud copy operation by sending a command to the remote server. The operation can transfer data between an instance and a cloud service.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"api_key":{"type":"string","description":"API key for authentication."},"dst":{"type":"string","description":"Destination path for the copy operation."},"flags":{"type":"array","description":"Additional flags for the operation.","items":{"type":"string"}},"instance_id":{"type":"string","description":"ID of the instance."},"selected":{"type":"string","description":"ID of the cloud connection."},"src":{"type":"string","description":"Source path for the copy operation."},"transfer":{"type":"string","description":"Type of transfer (e.g., \"Instance To Cloud\" or \"Cloud To Instance\")."}}},"example":{"api_key":"","dst":"","flags":[],"instance_id":"","selected":"","src":"","transfer":""}}}}}},"/api/v0/instances/bid_price/{id}/":{"put":{"tags":["Instances"],"parameters":[{"name":"id","in":"path","description":"Instance ID","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/instances","api_endpoint":"https://console.vast.ai/api/v0/instances/bid_price/{id}/"},"summary":"Change Bid","description":"Change the current bid price of an instance to a specified price.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"client_id":{"type":"string","description":"Client identifier (usually \"me\")","required":true},"price":{"type":"number","description":"Bid price in $/hour","required":true}}},"example":{"client_id":"","price":""}}}}}},"/api/v0/machines/{machine_id}/cleanup/":{"put":{"tags":["Machines"],"parameters":[{"name":"machine_id","in":"path","description":"The ID of the machine to clean up.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/machines","api_endpoint":"https://console.vast.ai/api/v0/machines/{machine_id}/cleanup/"},"summary":"Cleanup Machine","description":"This endpoint removes expired contracts on a specified machine, freeing up space.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/v0/auth/apikeys/":{"post":{"tags":["Accounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/accounts","api_endpoint":"https://console.vast.ai/api/v0/auth/apikeys/"},"summary":"Create Api-Key","description":"Creates a new API key with specified permissions for the authenticated user.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"key_params":{"type":"object","description":"Optional wildcard parameters for advanced keys","properties":{}},"name":{"type":"string","description":"Name for the API key","required":true},"permissions":{"type":"object","description":"JSON object containing permission definitions","properties":{}}}},"example":{"key_params":{},"name":"","permissions":{}}}}}},"get":{"tags":["Accounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/accounts","api_endpoint":"https://console.vast.ai/api/v0/auth/apikeys/"},"summary":"Show Api Keys","description":"Retrieves all API keys associated with the authenticated user.","security":[{"bearerAuth":[]}]}},"/api/v0/workergroups/":{"post":{"tags":["Serverless"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/serverless","api_endpoint":"https://console.vast.ai/api/v0/workergroups/"},"summary":"Create Workergroup","description":"Creates a new workergroup configuration that manages worker instances for a serverless endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"cold_mult":{"type":"number","description":"Cold start multiplier"},"cold_workers":{"type":"number","description":"Number of cold workers to maintain"},"endpoint_id":{"type":"number","description":"ID of existing endpoint group (alternative to endpoint_name)"},"endpoint_name":{"type":"string","description":"Name of the endpoint group"},"gpu_ram":{"type":"number","description":"Minimum GPU RAM in GB"},"launch_args":{"type":"string","description":"Additional launch arguments for worker instances"},"max_workers":{"type":"number","description":"Maximum number of worker instances"},"min_load":{"type":"number","description":"Minimum load threshold for scaling"},"search_params":{"type":"string","description":"Search query for finding worker instances (alternative to template)"},"target_util":{"type":"number","description":"Target GPU utilization"},"template_hash":{"type":"string","description":"Hash ID of template to use for worker instances"},"template_id":{"type":"number","description":"ID of template (alternative to template_hash)"},"test_workers":{"type":"number","description":"Number of test workers"}}},"example":{"cold_mult":"","cold_workers":"","endpoint_id":"","endpoint_name":"","gpu_ram":"","launch_args":"","max_workers":"","min_load":"","search_params":"","target_util":"","template_hash":"","template_id":"","test_workers":""}}}}},"get":{"tags":["Serverless"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/serverless","api_endpoint":"https://console.vast.ai/api/v0/workergroups/"},"summary":"Show Workergroup","description":"Retrieves the list of workergroups associated with the authenticated user.","security":[{"bearerAuth":[]}]}},"/api/v0/endptjobs/":{"post":{"tags":["Serverless"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/serverless","api_endpoint":"https://console.vast.ai/api/v0/endptjobs/"},"summary":"Create Endpoint","description":"This endpoint creates a new job processing endpoint with specified parameters.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"cold_mult":{"type":"number","description":"Multiplier for cold start."},"cold_workers":{"type":"number","description":"Number of cold workers."},"endpoint_name":{"type":"string","description":"Name of the endpoint."},"max_workers":{"type":"number","description":"Maximum number of workers."},"min_load":{"type":"number","description":"Minimum load for the endpoint."},"target_util":{"type":"number","description":"Target utilization for the endpoint."}}},"example":{"cold_mult":"","cold_workers":"","endpoint_name":"","max_workers":"","min_load":"","target_util":""}}}}},"get":{"tags":["Serverless"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/serverless","api_endpoint":"https://console.vast.ai/api/v0/endptjobs/"},"summary":"Show Endpoints","description":"Retrieve a list of endpoint jobs for the authenticated user.","security":[{"bearerAuth":[]}]}},"/api/v0/secrets/":{"post":{"tags":["Accounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/accounts","api_endpoint":"https://console.vast.ai/api/v0/secrets/"},"summary":"Create Env-Var","description":"Creates a new encrypted environment variable for the authenticated user.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"key":{"type":"string","description":"Environment variable key name (will be converted to uppercase)","required":true},"value":{"type":"string","description":"Secret value to be encrypted and stored","required":true}}},"example":{"key":"","value":""}}}}},"delete":{"tags":["Accounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/accounts","api_endpoint":"https://console.vast.ai/api/v0/secrets/"},"summary":"Delete Env Var","description":"Deletes an environment variable associated with the authenticated user.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Accounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/accounts","api_endpoint":"https://console.vast.ai/api/v0/secrets/"},"summary":"Show Env Vars","description":"Retrieve a list of environment variables (secrets) for the authenticated user.","security":[{"bearerAuth":[]}]},"put":{"tags":["Accounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/accounts","api_endpoint":"https://console.vast.ai/api/v0/secrets/"},"summary":"Update Env Var","description":"Updates the value of an existing environment variable for the authenticated user.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"key":{"type":"string","description":"The key of the environment variable to update (will be converted to uppercase)","required":true},"value":{"type":"string","description":"The new value for the environment variable","required":true}}},"example":{"key":"","value":""}}}}}},"/api/v0/asks/{id}/":{"put":{"tags":["Instances"],"parameters":[{"name":"id","in":"path","description":"ID of the offer to accept (ask_id)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/instances","api_endpoint":"https://console.vast.ai/api/v0/asks/{id}/"},"summary":"Create Instance","description":"Creates a new instance by accepting an \"ask\" contract from a provider.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"args":{"type":"array","description":"Arguments array to passed to the image entrypoint\n\nExample : `[\"bash\", \"-c\", \"env | grep _ >> /etc/environment; echo 'starting up'\"]`","items":{"type":"string"}},"args_str":{"type":"string","description":"Arguments string to pass to the entrypoint (alternative to args)\n\nExample : `args_str: bash -c \"env | grep _ >> /etc/environment; echo 'starting up'\"`"},"cancel_unavail":{"type":"boolean","description":"Whether to cancel if instance cannot start immediately. Defaults to false for interruptibles. Defaults to true for on-demand with target_state='running'"},"disk":{"type":"number","description":"Size of local disk partition (in GB)"},"env":{"type":"string","description":"Environment variables and port mappings in Docker flag format. When using a template, request `env` is merged with template `env` - existing keys are retained, new keys are appended, conflicting keys use the request value.\n\nExample: `\"-e HF_TOKEN=hf_xxx123456789 -e MODEL_ID=TheBloke/Llama-2-7B-Chat-GPTQ -p 8000:8000\"`"},"force":{"type":"boolean","description":"Skip sanity checks when creating from an existing instance"},"image":{"type":"string","description":"Docker image to use for the instance.","required":true},"image_login":{"type":"string","description":"Docker registry credentials if needed"},"jupyter_dir":{"type":"string","description":"Directory to launch Jupyter from\n\nExample : `/home/notebooks`"},"label":{"type":"string","description":"Custom name for the instance"},"lang_utf8":{"type":"boolean","description":"Set locale to C.UTF-8"},"onstart":{"type":"string","description":"Commands to run when instance starts\n\nExample : `env | grep _ >> /etc/environment; echo 'starting up'`"},"price":{"type":"number","description":"Bid price per machine (in $/hour). Only for interruptible instances"},"python_utf8":{"type":"boolean","description":"Set python's locale to C.UTF-8"},"runtype":{"type":"string","description":"Launch mode for the instance. If omitted, defaults to 'ssh' unless `args/args_str` is provided.","enum":["ssh","jupyter","args","ssh_proxy","ssh_direct","jupyter_proxy","jupyter_direct"]},"target_state":{"type":"string","description":"Desired initial state of the instance","enum":["running","stopped"]},"template_hash_id":{"type":"string","description":"Content-based hash ID of a template to use as base configuration. Template values are merged with or overridden by request parameters (see precedence rules in endpoint description). When using a template, the `image` field is optional as the template provides it.\n\nExample: `4e17788f74f075dd9aab7d0d4427968f`"},"use_jupyter_lab":{"type":"boolean","description":"Launch instance with jupyter lab instead of notebook"},"user":{"type":"string","description":"User to use with docker create (breaks some images, use with caution)"},"vm":{"type":"boolean","description":"Whether this is a VM instance"},"volume_info":{"type":"object","description":"Volume creation/linking information","properties":{"create_new":{"type":"boolean","description":"Set to `true` to create a new volume, `false` to link an existing volume"},"mount_path":{"type":"string","description":"Mount path for the volume inside the container (e.g., `/workspace`)"},"size":{"type":"number","description":"Size of the volume in GB. Only used when `create_new` is true"},"volume_id":{"type":"number","description":"If `create_new` is false: existing volume ID (from `show volumes`). If `create_new` is true: volume offer ID (from `search volumes`)"}}}}},"example":{"args":[],"args_str":"","cancel_unavail":"","disk":"","env":"","force":"","image":"","image_login":"","jupyter_dir":"","label":"","lang_utf8":"","onstart":"","price":"","python_utf8":"","runtype":"","target_state":"","template_hash_id":"","use_jupyter_lab":"","user":"","vm":"","volume_info":{}}}}}}},"/api/v0/network_volume/":{"put":{"tags":["Network Volumes"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/volumes","api_endpoint":"https://console.vast.ai/api/v0/network_volume/"},"summary":"Create Network-Volume","description":"Creates a network volume from an offer.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"id":{"type":"number","description":"ID of network volume ask being accepted","required":true},"name":{"type":"string","description":"optional name for network volume being created"},"size":{"type":"number","description":"size of network volume in GB being created","required":true}}},"example":{"id":"","name":"","size":""}}}}},"post":{"tags":["Network Volumes"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/volumes","api_endpoint":"https://console.vast.ai/api/v0/network_volume/"},"summary":"List Network-Volume","description":"Lists a network disk for rent as network volumes, or updates an existing listing with a new price/size/end date/discount.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"credit_discount_max":{"type":"number","description":"Maximum discount rate allowed for prepaid credits"},"disk_id":{"type":"number","description":"ID of network disk for which offer is being created","required":true},"end_date":{"type":"number","description":"Unix timestamp for when the listing expires"},"price_disk":{"type":"number","description":"Price per GB of network volume storage"},"size":{"type":"number","description":"Size in GB of the amount of space available to be rented"}}},"example":{"credit_discount_max":"","disk_id":"","end_date":"","price_disk":"","size":""}}}}}},"/api/v0/ssh/":{"post":{"tags":["Accounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/accounts","api_endpoint":"https://console.vast.ai/api/v0/ssh/"},"summary":"Create Ssh-Key","description":"Creates a new SSH key and associates it with your account.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ssh_key":{"type":"string","description":"The public SSH key to add (from .pub file)","required":true}}},"example":{"ssh_key":""}}}}},"get":{"tags":["Accounts"],"parameters":[{"name":"Authorization","in":"query","description":"Bearer token for user authentication.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/accounts","api_endpoint":"https://console.vast.ai/api/v0/ssh/"},"summary":"Show Ssh Keys","description":"Retrieve a list of SSH keys associated with the authenticated user's account.","security":[{"bearerAuth":[]}]}},"/api/v0/users/":{"post":{"tags":["Accounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/accounts","api_endpoint":"https://console.vast.ai/api/v0/users/"},"summary":"Create Subaccount","description":"Creates either a standalone user account or a subaccount under a parent account. Subaccounts can be restricted to host-only functionality.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"captcha":{"type":"string","description":"Captcha token (required for non-subaccounts)"},"email":{"type":"string","description":"User's email address","required":true},"host_only":{"type":"boolean","description":"If true, account is restricted to host functionality only"},"parent_id":{"type":"string","description":"Parent account ID for subaccounts. Use \"me\" for current user."},"password":{"type":"string","description":"Account password","required":true},"ssh_key":{"type":"string","description":"Optional SSH public key"},"username":{"type":"string","description":"Desired username","required":true}}},"example":{"captcha":"","email":"","host_only":"","parent_id":"","password":"","ssh_key":"","username":""}}}}},"put":{"tags":["Accounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/accounts","api_endpoint":"https://console.vast.ai/api/v0/users/"},"summary":"Set User","description":"Updates the user data for the authenticated user.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"fullname":{"type":"string","description":"Full name of the user."},"normalized_email":{"type":"string","description":"Normalized email address."},"username":{"type":"string","description":"Username of the user."}}},"example":{"fullname":"","normalized_email":"","username":""}}}}}},"/api/v0/team/":{"post":{"tags":["Team"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/team","api_endpoint":"https://console.vast.ai/api/v0/team/"},"summary":"Create Team","description":"Creates a new [team](https://docs.vast.ai/documentation/teams/teams-overview) with given name and following default roles:","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"team_name":{"type":"string","description":"Value","required":true},"transfer_credit":{"type":"number","description":"Credits to transfer from personal account to team"}}},"example":{"team_name":"","transfer_credit":""}}}}},"delete":{"tags":["Team"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/team","api_endpoint":"https://console.vast.ai/api/v0/team/"},"summary":"Destroy Team","description":"Deletes a team and all associated data including API keys, rights, invitations, memberships and metadata. The team owner's master API key is converted to a normal client key.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/v0/team/roles/":{"post":{"tags":["Team"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/team","api_endpoint":"https://console.vast.ai/api/v0/team/roles/"},"summary":"Create Team Role","description":"Creates a new role within a team. Only team owners or managers with the appropriate permissions can perform this operation.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Name for the new role","required":true},"permissions":{"type":"object","description":"JSON object containing permission definitions","required":true,"properties":{"api":{"type":"object","description":"API permissions"}}}}},"example":{"name":"","permissions":{}}}}}}},"/api/v0/template/":{"post":{"tags":["Templates"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/templates","api_endpoint":"https://console.vast.ai/api/v0/template/"},"summary":"Create Template","description":"Creates a new template for launching instances.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"args_str":{"type":"string","description":"Arguments string passed to the container entrypoint when runtype is `args`"},"desc":{"type":"string","description":"Short description of the template"},"docker_login_pass":{"type":"string","description":"Access token or password for private Docker repo."},"docker_login_repo":{"type":"string","description":"Name of the private Docker repo (i.e docker.io)"},"docker_login_user":{"type":"string","description":"Username for private Docker repo"},"env":{"type":"string","description":"Environment variables and port mappings in Docker flag format.\n\nExample: `\"-e HF_TOKEN=hf_xxx123456789 -e MODEL_ID=TheBloke/Llama-2-7B-Chat-GPTQ -p 8000:8000\"`"},"extra_filters":{"type":"object","description":"Additional machine search filters. Example: `{\"cuda_max_good\": {\"gte\": 12.6}}`","properties":{}},"hash_id":{"type":"string","description":"Content-based hash ID of the template. Can be included when editing but will change based on new content."},"href":{"type":"string","description":"Link to Docker Hub or image documentation"},"image":{"type":"string","description":"Docker image path. Used when launching instances from this template.","required":true},"jup_direct":{"type":"boolean","description":"Enable direct Jupyter connection"},"jupyter_dir":{"type":"string","description":"Directory to launch Jupyter from\n\nExample : `/home/notebooks`"},"name":{"type":"string","description":"Name of the template","required":true},"onstart":{"type":"string","description":"Commands to run when instance starts\n\nExample : `env | grep _ >> /etc/environment; echo 'starting up'`"},"private":{"type":"boolean","description":"Whether the template is private (not publicly searchable)"},"readme":{"type":"string","description":"Longer documentation/readme content for the template"},"recommended_disk_space":{"type":"number","description":"Recommended disk space in GB. Defaults to 8GB if not specified."},"repo":{"type":"string","description":"Repository identifier (e.g., `library/ubuntu`)"},"runtype":{"type":"string","description":"Launch mode for the instance. Defaults to `args`. Recommended - use `ssh` with `ssh_direct: true` for reliable SSH access.","enum":["ssh","jupyter","args"]},"ssh_direct":{"type":"boolean","description":"Enable direct SSH connection"},"tag":{"type":"string","description":"Docker image tag specifying version of the image. Defaults to `latest`. Can also be included in the `image` field instead."},"use_jupyter_lab":{"type":"boolean","description":"Use JupyterLab instead of Jupyter Notebook"},"use_ssh":{"type":"boolean","description":"Enable SSH access to instances created from this template"},"volume_info":{"type":"object","description":"UI hint for volume configuration. Note: This does not affect instance creation - use `volume_info` in the instance creation request to actually attach volumes.","properties":{}}}},"example":{"args_str":"","desc":"","docker_login_pass":"","docker_login_repo":"","docker_login_user":"","env":"","extra_filters":{},"hash_id":"","href":"","image":"","jup_direct":"","jupyter_dir":"","name":"","onstart":"","private":"","readme":"","recommended_disk_space":"","repo":"","runtype":"","ssh_direct":"","tag":"","use_jupyter_lab":"","use_ssh":"","volume_info":{}}}}}},"delete":{"tags":["Templates"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/templates","api_endpoint":"https://console.vast.ai/api/v0/template/"},"summary":"Delete Template","description":"Deletes an existing template.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"put":{"tags":["Templates"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/templates","api_endpoint":"https://console.vast.ai/api/v0/template/"},"summary":"Edit Template","description":"Edits an existing template in place.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"desc":{"type":"string","description":"Short description of the template"},"hash_id":{"type":"string","description":"Hash ID of the template to edit. Required for identifying which template to update.","required":true},"image":{"type":"string","description":"Docker image path"},"name":{"type":"string","description":"Name of the template"},"recommended_disk_space":{"type":"number","description":"Recommended disk space in GB"}}},"example":{"desc":"","hash_id":"","image":"","name":"","recommended_disk_space":""}}}}},"get":{"tags":["Search"],"parameters":[{"name":"order_by","in":"query","description":"Column to order the results by.","required":false,"schema":{"type":"string","example":""}},{"name":"select_cols","in":"query","description":"JSON-encoded array of columns to return. Example: `[\"*\"]` for all columns or `[\"id\", \"name\", \"hash_id\"]` for specific columns.","required":false,"schema":{"type":"string","example":""}},{"name":"select_filters","in":"query","description":"JSON-encoded filter object. Format: `{\"field\": {\"op\": value}}`. Example: `{\"use_ssh\": {\"eq\": true}, \"recommended\": {\"eq\": true}}` or `{\"count_created\": {\"gt\": 100}}`","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/search","api_endpoint":"https://console.vast.ai/api/v0/template/"},"summary":"Search Templates","description":"Searches for templates using filter-based queries.","security":[{"bearerAuth":[]}]}},"/api/v0/auth/apikeys/{id}/":{"delete":{"tags":["Accounts"],"parameters":[{"name":"id","in":"path","description":"ID of the API key to delete","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/accounts","api_endpoint":"https://console.vast.ai/api/v0/auth/apikeys/{id}/"},"summary":"Delete Api Key","description":"Deletes an existing API key belonging to the authenticated user.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/v0/workergroups/{id}/":{"delete":{"tags":["Serverless"],"parameters":[{"name":"id","in":"path","description":"ID of the workergroup to delete","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/serverless","api_endpoint":"https://console.vast.ai/api/v0/workergroups/{id}/"},"summary":"Delete Workergroup","description":"Deletes an existing workergroup.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"put":{"tags":["Serverless"],"parameters":[{"name":"id","in":"path","description":"The ID of the workergroup to update.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/serverless","api_endpoint":"https://console.vast.ai/api/v0/workergroups/{id}/"},"summary":"Update Workergroup","description":"Updates the properties of an existing workergroup based on the provided parameters.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"cold_mult":{"type":"number","description":"Cold multiplier for the workergroup."},"endpoint_id":{"type":"number","description":"Deployment endpoint ID."},"endpoint_name":{"type":"string","description":"Deployment endpoint name."},"gpu_ram":{"type":"number","description":"Estimated GPU RAM requirement."},"launch_args":{"type":"string","description":"Launch arguments for creating instances."},"min_load":{"type":"number","description":"Minimum load for the workergroup."},"search_params":{"type":"string","description":"Search parameters for offers (JSON object or query string)."},"target_util":{"type":"number","description":"Target utilization for the workergroup."},"template_hash":{"type":"string","description":"Template hash for the workergroup."},"template_id":{"type":"number","description":"Template ID for the workergroup."},"test_workers":{"type":"number","description":"Number of test workers for performance estimation."}}},"example":{"cold_mult":"","endpoint_id":"","endpoint_name":"","gpu_ram":"","launch_args":"","min_load":"","search_params":"","target_util":"","template_hash":"","template_id":"","test_workers":""}}}}}},"/api/v0/endptjobs/{id}/":{"delete":{"tags":["Serverless"],"parameters":[{"name":"id","in":"path","description":"ID of the endpoint group to delete","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/serverless","api_endpoint":"https://console.vast.ai/api/v0/endptjobs/{id}/"},"summary":"Delete Endpoint","description":"Deletes an endpoint group by ID. Associated workergroups will also be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"put":{"tags":["Serverless"],"parameters":[{"name":"id","in":"path","description":"ID of the endpoint group to update","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/serverless","api_endpoint":"https://console.vast.ai/api/v0/endptjobs/{id}/"},"summary":"Update Endpoint","description":"Updates the specified endpoint group with the provided parameters.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"cold_mult":{"type":"number","description":"Cold/stopped instance capacity target as multiple of hot capacity target"},"cold_workers":{"type":"number","description":"Min number of workers to keep 'cold' when you have no load"},"endpoint_name":{"type":"string","description":"Deployment endpoint name"},"max_workers":{"type":"number","description":"Max number of workers your endpoint group can have"},"min_load":{"type":"number","description":"Minimum floor load in perf units/s (token/s for LLMs)"},"target_util":{"type":"number","description":"Target capacity utilization (fraction, max 1.0)"}}},"example":{"cold_mult":"","cold_workers":"","endpoint_name":"","max_workers":"","min_load":"","target_util":""}}}}}},"/api/v0/ssh/{id}/":{"delete":{"tags":["Accounts"],"parameters":[{"name":"id","in":"path","description":"ID of the SSH key to delete","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/accounts","api_endpoint":"https://console.vast.ai/api/v0/ssh/{id}/"},"summary":"Delete Ssh Key","description":"Removes an SSH key from the authenticated user's account","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"put":{"tags":["Accounts"],"parameters":[{"name":"id","in":"path","description":"ID of the SSH key to update","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/accounts","api_endpoint":"https://console.vast.ai/api/v0/ssh/{id}/"},"summary":"Update Ssh Key","description":"Updates the specified SSH key with the provided value.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ssh_key":{"type":"string","description":"The new value for the SSH key","required":true}}},"example":{"ssh_key":""}}}}}},"/api/v0/volumes/":{"delete":{"tags":["Volumes"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/volumes","api_endpoint":"https://console.vast.ai/api/v0/volumes/"},"summary":"Delete Volume","description":"Delete a volume by its ID.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"put":{"tags":["Volumes"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/volumes","api_endpoint":"https://console.vast.ai/api/v0/volumes/"},"summary":"Rent Volume","description":"Rent/create a new volume with specified parameters.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"id":{"type":"number","description":"ID for the volume","required":true},"size":{"type":"number","description":"Size in GB (Defaults to 15)"}}},"example":{"id":"","size":""}}}}},"get":{"tags":["Volumes"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/volumes","api_endpoint":"https://console.vast.ai/api/v0/volumes/"},"summary":"List Volumes","description":"Retrieve information about all volumes rented by you.","security":[{"bearerAuth":[]}]}},"/api/v0/instances/{id}/":{"delete":{"tags":["Instances"],"parameters":[{"name":"id","in":"path","description":"ID of the instance to destroy","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/instances","api_endpoint":"https://console.vast.ai/api/v0/instances/{id}/"},"summary":"Destroy Instance","description":"Destroys/deletes an instance permanently. This is irreversible and will delete all data.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"put":{"tags":["Instances"],"parameters":[{"name":"id","in":"path","description":"ID of the instance to modify","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/instances","api_endpoint":"https://console.vast.ai/api/v0/instances/{id}/"},"summary":"Manage Instance","description":"Manage instance state and labels. The operation is determined by the request body parameters.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"label":{"type":"string","description":"Text label to assign to the instance (optional)"},"state":{"type":"string","description":"Change instance state (optional)","enum":["stopped","running"]}}},"example":{"label":"","state":""}}}}},"get":{"tags":["Instances"],"parameters":[{"name":"id","in":"path","description":"The instance (contract) ID to retrieve.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/instances","api_endpoint":"https://console.vast.ai/api/v0/instances/{id}/"},"summary":"Show Instance","description":"Retrieves the details of a specific instance for the authenticated user.","security":[{"bearerAuth":[]}]}},"/api/v0/instances/{id}/ssh/{ssh_key_id}/":{"delete":{"tags":["Instances"],"parameters":[{"name":"id","in":"path","description":"ID of the instance to detach the SSH key from","required":true,"schema":{"type":"number","example":""}},{"name":"ssh_key_id","in":"path","description":"Numeric ID of the SSH key to detach. Obtainable via `show ssh-keys` command","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/instances","api_endpoint":"https://console.vast.ai/api/v0/instances/{id}/ssh/{ssh_key_id}/"},"summary":"Detach Ssh-Key","description":"Detaches an SSH key from a specified instance, removing SSH access for that key.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/v0/instances/command/{id}/":{"put":{"tags":["Instances"],"parameters":[{"name":"id","in":"path","description":"ID of the instance to execute command on","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/instances","api_endpoint":"https://console.vast.ai/api/v0/instances/command/{id}/"},"summary":"Execute","description":"Executes a constrained remote command on a specified instance.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"command":{"type":"string","description":"Command to execute on the instance","required":true}}},"example":{"command":""}}}}}},"/get_workergroup_logs/":{"post":{"tags":["Serverless"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/serverless","api_endpoint":"https://console.vast.ai/get_workergroup_logs/"},"summary":"Get Workergroup Logs","description":"Retrieves logs for a specific workergroup by ID.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"id":{"type":"number","description":"ID of the worker group","required":true},"tail":{"type":"number","description":"Number of log lines to retrieve from the end"}}},"example":{"id":"","tail":""}}}}}},"/get_workergroup_workers/":{"post":{"tags":["Serverless"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/serverless","api_endpoint":"https://console.vast.ai/get_workergroup_workers/"},"summary":"Get Workergroup Workers","description":"Retrieves the current list and status of workers for a specific workergroup.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"id":{"type":"number","description":"ID of the workergroup to monitor","required":true}}},"example":{"id":""}}}}}},"/get_endpoint_logs/":{"post":{"tags":["Serverless"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/serverless","api_endpoint":"https://console.vast.ai/get_endpoint_logs/"},"summary":"Get Endpoint Logs","description":"Retrieves logs for a specific endpoint by name.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","description":"Name of the endpoint","required":true},"tail":{"type":"number","description":"Number of log lines to retrieve from the end"}}},"example":{"endpoint":"","tail":""}}}}}},"/get_endpoint_workers/":{"post":{"tags":["Serverless"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/serverless","api_endpoint":"https://console.vast.ai/get_endpoint_workers/"},"summary":"Get Endpoint Workers","description":"Retrieves the current list and status of workers for a specific endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"id":{"type":"number","description":"ID of the endpoint to monitor","required":true}}},"example":{"id":""}}}}}},"/api/v0/team/invite/":{"post":{"tags":["Team"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/team","api_endpoint":"https://console.vast.ai/api/v0/team/invite/"},"summary":"Invite Team Member","description":"Sends an invitation email to the specified user to join the team with the given role.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"Email address of the user to invite","required":true},"role":{"type":"string","description":"Role to assign to the new team member","required":true}}},"example":{"email":"","role":""}}}}}},"/api/v0/machines/create_asks/":{"put":{"tags":["Machines"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/machines","api_endpoint":"https://console.vast.ai/api/v0/machines/create_asks/"},"summary":"List Machine","description":"Creates or updates ask contracts for a machine to list it for rent on the vast.ai platform.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"credit_discount_max":{"type":"number","description":"Maximum discount rate allowed for prepaid credits"},"end_date":{"type":"number","description":"Unix timestamp for when the listing expires"},"machine":{"type":"number","description":"ID of the machine to list","required":true},"min_chunk":{"type":"number","description":"Minimum number of GPUs that must be rented together"},"price_disk":{"type":"number","description":"Price per GB of disk storage"},"price_gpu":{"type":"number","description":"Price per GPU per hour"},"price_inetd":{"type":"number","description":"Price per GB of download bandwidth"},"price_inetu":{"type":"number","description":"Price per GB of upload bandwidth"},"price_min_bid":{"type":"number","description":"Minimum bid price allowed"}}},"example":{"credit_discount_max":"","end_date":"","machine":"","min_chunk":"","price_disk":"","price_gpu":"","price_inetd":"","price_inetu":"","price_min_bid":""}}}}}},"/api/v0/instances/request_logs/{id}":{"put":{"tags":["Instances"],"parameters":[{"name":"id","in":"path","description":"ID of the instance to get logs from","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/instances","api_endpoint":"https://console.vast.ai/api/v0/instances/request_logs/{id}"},"summary":"Show Logs","description":"Request logs from a specific instance. The logs will be uploaded to S3 and can be retrieved from a generated URL. Supports both container logs and daemon system logs.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"daemon_logs":{"type":"string","description":"If \"true\", fetch daemon system logs instead of container logs","enum":["true"]},"filter":{"type":"string","description":"Grep filter to apply to log entries"},"tail":{"type":"string","description":"Number of lines to show from end of logs"}}},"example":{"daemon_logs":"","filter":"","tail":""}}}}}},"/api/v0/instances/prepay/{id}/":{"put":{"tags":["Instances"],"parameters":[{"name":"id","in":"path","description":"ID of the instance to prepay for","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/instances","api_endpoint":"https://console.vast.ai/api/v0/instances/prepay/{id}/"},"summary":"Prepay Instance","description":"Deposit credits into a reserved instance to receive usage discounts.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"amount":{"type":"number","description":"Amount of credits to prepay","required":true}}},"example":{"amount":""}}}}}},"/api/v0/instances/reboot/{id}/":{"put":{"tags":["Instances"],"parameters":[{"name":"id","in":"path","description":"ID of the instance to reboot","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/instances","api_endpoint":"https://console.vast.ai/api/v0/instances/reboot/{id}/"},"summary":"Reboot Instance","description":"Stops and starts a container without losing GPU priority. Updates container status to 'rebooting' and executes docker stop/start commands on the host machine.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/v0/instances/recycle/{id}/":{"put":{"tags":["Instances"],"parameters":[{"name":"id","in":"path","description":"ID of the instance to recycle","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/instances","api_endpoint":"https://console.vast.ai/api/v0/instances/recycle/{id}/"},"summary":"Recycle Instance","description":"Destroys and recreates container in place (from newly pulled image) without losing GPU priority.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/v0/machines/{machine_id}/defjob/":{"delete":{"tags":["Machines"],"parameters":[{"name":"machine_id","in":"path","description":"ID of the machine to remove the default job from.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/machines","api_endpoint":"https://console.vast.ai/api/v0/machines/{machine_id}/defjob/"},"summary":"Remove Defjob","description":"Deletes the default job (background instances) for a specified machine.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/v0/team/members/{id}":{"delete":{"tags":["Team"],"parameters":[{"name":"id","in":"path","description":"User ID of the team member to remove","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/team","api_endpoint":"https://console.vast.ai/api/v0/team/members/{id}"},"summary":"Remove Team Member","description":"Removes a member from the team by revoking their team-related API keys and updating membership status. Cannot remove the team owner.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/v0/team/roles/{name}":{"delete":{"tags":["Team"],"parameters":[{"name":"name","in":"path","description":"Name of the role to remove","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/team","api_endpoint":"https://console.vast.ai/api/v0/team/roles/{name}"},"summary":"Remove Team Role","description":"Removes a role from the team. Cannot remove the team owner role.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/v0/machines/{machine_id}/reports/":{"get":{"tags":["Machines"],"parameters":[{"name":"machine_id","in":"path","description":"The unique identifier of the machine.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/machines","api_endpoint":"https://console.vast.ai/api/v0/machines/{machine_id}/reports/"},"summary":"Show Reports","description":"Retrieves a list of the most recent reports for a given machine. Each report includes details such as the problem identified, a message describing the issue, and the timestamp when the report was created.","security":[{"bearerAuth":[]}]}},"/route/":{"post":{"tags":["Serverless"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/serverless","api_endpoint":"https://console.vast.ai/route/"},"summary":"Route","description":"Calls on the serverless engine to retrieve a GPU instance address within your endpoint for processing a request.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"cost":{"type":"number","description":"The estimated compute resources for the request","required":true},"endpoint":{"type":"string","description":"Name of the endpoint","required":true}}},"example":{"cost":"","endpoint":""}}}}}},"/api/v0/machines/{machine_id}/dnotify":{"put":{"tags":["Machines"],"parameters":[{"name":"machine_id","in":"path","description":"ID of the machine to schedule maintenance for.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/machines","api_endpoint":"https://console.vast.ai/api/v0/machines/{machine_id}/dnotify"},"summary":"Schedule Maint","description":"Schedules a maintenance window for a specified machine and notifies clients.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"duration":{"type":"number","description":"Duration of the maintenance window in hours.","required":true},"maintenance_category":{"type":"string","description":"Category of the maintenance.","enum":["power","internet","disk","gpu","software","other"]},"maintenance_reason":{"type":"string","description":"Reason for the maintenance."},"sdate":{"type":"string","description":"Start date and time of the maintenance window.","required":true}}},"example":{"duration":"","maintenance_category":"","maintenance_reason":"","sdate":""}}}}}},"/api/v0/benchmarks/":{"get":{"tags":["Search"],"parameters":[{"name":"query","in":"query","description":"Search query string to filter benchmarks.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/search","api_endpoint":"https://console.vast.ai/api/v0/benchmarks/"},"summary":"Search Benchmarks","description":"Retrieve benchmark data based on search parameters.","security":[{"bearerAuth":[]}]}},"/api/v0/network_volumes/search/":{"post":{"tags":["Network Volumes"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/volumes","api_endpoint":"https://console.vast.ai/api/v0/network_volumes/search/"},"summary":"Search Network Volumes","description":"Search for available network volume offers with advanced filtering and sorting.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"q":{"type":"object","description":"Value","properties":{"disk_bw":{"type":"object","description":"Disk read bandwidth in MB/s"},"duration":{"type":"object","description":"Maximum rental duration in days"},"geolocation":{"type":"object","description":"Cluster location (two letter country code)"},"inet_down":{"type":"object","description":"Download bandwidth (MB/s)"},"inet_up":{"type":"object","description":"Upload bandwidth (MB/s)"},"limit":{"type":"number","description":"Max results to return"},"order":{"type":"array","description":"Sort fields and directions"},"reliability2":{"type":"object","description":"Cluster reliability score (0-1)"},"storage_cost":{"type":"object","description":"Storage cost in $/GB/month"},"verified":{"type":"object","description":"Display offers where all machines in cluster are verified"}}}}},"example":{"q":{}}}}}}},"/api/v0/bundles/":{"post":{"tags":["Search"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/search","api_endpoint":"https://console.vast.ai/api/v0/bundles/"},"summary":"Search Offers","description":"Search for available GPU machine offers with advanced filtering and sorting.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"type":{"type":"string","description":"Instance type for the offer. Affects pricing calculation.\n\n- **ondemand**: Fixed pricing based on listed rates. Default.\n- **bid** (interruptible): Uses minimum bid price. Lower cost but may be interrupted if outbid.\n- **reserved**: Reserved instance pricing.","enum":["ondemand","bid","reserved"]},"allocated_storage":{"type":"number","description":"Storage allocation size in GB for the instance.\nThis sets the disk size when creating the instance and cannot be changed later.\nDefault is 8GB."},"bw_nvlink":{"type":"object","description":"NVLink interconnect bandwidth in GB/s. Use when filtering for multi-GPU systems with high-speed NVLink.","properties":{}},"compute_cap":{"type":"object","description":"CUDA compute capability x 100. Use 650 for compute capability 6.5 or 700 for 7.0.","properties":{}},"cpu_arch":{"type":"object","description":"Host machine CPU architecture (Default is amd64). Example: {\"eq\": \"amd64\"}","properties":{}},"cpu_cores":{"type":"object","description":"Number of virtual CPUs","properties":{}},"cpu_cores_effective":{"type":"object","description":"Effective vCPU count for the offer","properties":{}},"cpu_ghz":{"type":"object","description":"CPU clock speed in GHz","properties":{}},"cpu_ram":{"type":"object","description":"CPU RAM in MB","properties":{}},"cuda_max_good":{"type":"object","description":"Maximum supported CUDA version","properties":{}},"datacenter":{"type":"object","description":"Show only datacenter offers","properties":{}},"direct_port_count":{"type":"object","description":"Number of direct ports","properties":{}},"disk_bw":{"type":"object","description":"Disk read bandwidth in MB/s","properties":{}},"disk_space":{"type":"object","description":"Disk storage space in GB","properties":{}},"dlperf":{"type":"object","description":"Deep Learning performance score","properties":{}},"dlperf_per_dphtotal":{"type":"object","description":"DLPerf per dollar per hour","properties":{}},"dph_total":{"type":"object","description":"Total $/hour rental cost. Example: {\"lte\": 0.5}","properties":{}},"driver_version":{"type":"object","description":"NVIDIA driver version in the format \"XXX.XX.XX\"","properties":{}},"duration":{"type":"object","description":"Minimum required rental duration in seconds (the offer must be available for at least this long from now).","properties":{}},"external":{"type":"object","description":"Show external offers in addition to datacenter offers","properties":{}},"flops_per_dphtotal":{"type":"object","description":"TFLOPs per $/hour","properties":{}},"geolocation":{"type":"object","description":"Machine location (two letter country code). Example: {\"in\": [\"US\", \"CA\"]}","properties":{"in":{"type":"array","description":"Value"}}},"gpu_arch":{"type":"object","description":"Host machine GPU architecture (e.g. nvidia, amd). Example: {\"eq\": \"nvidia\"}","properties":{}},"gpu_display_active":{"type":"object","description":"Whether the GPU has an attached display","properties":{}},"gpu_frac":{"type":"object","description":"Fraction of the total GPU resources being offered","properties":{}},"gpu_max_power":{"type":"object","description":"GPU power limit in watts","properties":{}},"gpu_max_temp":{"type":"object","description":"GPU temperature limit in Celsius","properties":{}},"gpu_mem_bw":{"type":"object","description":"GPU memory bandwidth in GB/s","properties":{}},"gpu_name":{"type":"object","description":"GPU model name. Example: {\"eq\": \"RTX_4090\"} or {\"in\": [\"RTX_3090\", \"RTX_4090\"]}","properties":{"in":{"type":"array","description":"Value"}}},"gpu_ram":{"type":"object","description":"GPU RAM in MB. Example: {\"gte\": 24000}","properties":{}},"gpu_total_ram":{"type":"object","description":"Total GPU RAM across all GPUs in MB","properties":{}},"has_avx":{"type":"object","description":"CPU supports AVX instruction set","properties":{}},"host_id":{"type":"object","description":"Host user ID","properties":{}},"id":{"type":"object","description":"Offer ID","properties":{}},"inet_down":{"type":"object","description":"Download bandwidth (MB/s)","properties":{}},"inet_down_cost":{"type":"object","description":"Download bandwidth cost ($/GB)","properties":{}},"inet_up":{"type":"object","description":"Upload bandwidth (MB/s)","properties":{}},"inet_up_cost":{"type":"object","description":"Upload bandwidth cost ($/GB)","properties":{}},"limit":{"type":"number","description":"Max offers to return"},"machine_id":{"type":"object","description":"Filter by specific host machine ID","properties":{}},"min_bid":{"type":"object","description":"Minimum bid price ($/hour)","properties":{}},"mobo_name":{"type":"object","description":"Motherboard name","properties":{}},"num_gpus":{"type":"object","description":"Number of GPUs. Example: {\"gte\": 4} or {\"in\": [1, 2, 4, 8]}","properties":{"in":{"type":"array","description":"Value"}}},"order":{"type":"array","description":"Sort fields and directions","items":{"type":"string"}},"os_version":{"type":"object","description":"Host machine Ubuntu OS version","properties":{}},"pci_gen":{"type":"object","description":"PCIe generation","properties":{}},"pcie_bw":{"type":"object","description":"PCIe bandwidth (CPU to GPU)","properties":{}},"reliability":{"type":"object","description":"Machine reliability score (0-1). Example: {\"gte\": 0.99}","properties":{}},"rentable":{"type":"object","description":"Whether machine is rentable","properties":{"eq":{"type":"boolean","description":"Value"}}},"rented":{"type":"object","description":"When set to true, include offers where the calling user already has rented GPUs.\nThis is useful for finding offers on machines you're already renting.","properties":{"eq":{"type":"boolean","description":"Value"}}},"static_ip":{"type":"object","description":"Whether the IP address is static/stable","properties":{}},"storage_cost":{"type":"object","description":"Storage cost in $/GB/month","properties":{}},"total_flops":{"type":"object","description":"Total theoretical GPU compute performance (TFLOPs) across all GPUs.","properties":{}},"ubuntu_version":{"type":"object","description":"Host machine Ubuntu OS version (alias for os_version)","properties":{}},"verification":{"type":"object","description":"Machine verification status string (verified, deverified, unverified). Example: {\"eq\": \"verified\"}","properties":{}},"verified":{"type":"object","description":"Machine verification status","properties":{"eq":{"type":"boolean","description":"Value"}}},"vms_enabled":{"type":"object","description":"Whether the machine is a VM instance","properties":{}}}},"example":{"type":"","allocated_storage":"","bw_nvlink":{},"compute_cap":{},"cpu_arch":{},"cpu_cores":{},"cpu_cores_effective":{},"cpu_ghz":{},"cpu_ram":{},"cuda_max_good":{},"datacenter":{},"direct_port_count":{},"disk_bw":{},"disk_space":{},"dlperf":{},"dlperf_per_dphtotal":{},"dph_total":{},"driver_version":{},"duration":{},"external":{},"flops_per_dphtotal":{},"geolocation":{},"gpu_arch":{},"gpu_display_active":{},"gpu_frac":{},"gpu_max_power":{},"gpu_max_temp":{},"gpu_mem_bw":{},"gpu_name":{},"gpu_ram":{},"gpu_total_ram":{},"has_avx":{},"host_id":{},"id":{},"inet_down":{},"inet_down_cost":{},"inet_up":{},"inet_up_cost":{},"limit":"","machine_id":{},"min_bid":{},"mobo_name":{},"num_gpus":{},"order":[],"os_version":{},"pci_gen":{},"pcie_bw":{},"reliability":{},"rentable":{},"rented":{},"static_ip":{},"storage_cost":{},"total_flops":{},"ubuntu_version":{},"verification":{},"verified":{},"vms_enabled":{}}}}}}},"/api/v0/volumes/search/":{"post":{"tags":["Volumes"],"parameters":[{"name":"q","in":"query","description":"Query parameters for filtering volume search results","required":false,"schema":{"type":"object","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/volumes","api_endpoint":"https://console.vast.ai/api/v0/volumes/search/"},"summary":"Search Volumes","description":"Search for available volumes based on specified criteria.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"limit":{"type":"number","description":"Maximum number of results to return"}}},"example":{"limit":""}}}}}},"/api/v0/machines/create_bids/":{"put":{"tags":["Machines"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/machines","api_endpoint":"https://console.vast.ai/api/v0/machines/create_bids/"},"summary":"Set Defjob","description":"Creates default jobs (background instances) for a specified machine with the given parameters.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"args":{"type":"array","description":"Arguments for the Docker image.","items":{"type":"string"}},"image":{"type":"string","description":"Docker image to use for the job.","required":true},"machine":{"type":"number","description":"ID of the machine to create jobs for.","required":true},"price_gpu":{"type":"number","description":"Price per GPU per day.","required":true},"price_inetd":{"type":"number","description":"Price for internet download.","required":true},"price_inetu":{"type":"number","description":"Price for internet upload.","required":true}}},"example":{"args":[],"image":"","machine":"","price_gpu":"","price_inetd":"","price_inetu":""}}}}}},"/api/v0/machines/{machine_id}/minbid/":{"put":{"tags":["Machines"],"parameters":[{"name":"machine_id","in":"path","description":"The ID of the machine.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/machines","api_endpoint":"https://console.vast.ai/api/v0/machines/{machine_id}/minbid/"},"summary":"Set Min-Bid","description":"Sets the minimum bid price for a specified machine.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"price":{"type":"number","description":"Minimum bid price for the machine.","required":true}}},"example":{"price":""}}}}}},"/api/v0/charges/":{"get":{"tags":["Billing"],"parameters":[{"name":"after_token","in":"query","description":"Pass the `next_token` value from the previous response to fetch the next page of results. When the response returns `next_token: null`, there are no more pages.","required":false,"schema":{"type":"string","example":""}},{"name":"format","in":"query","description":"- `table` (default) flat list of per-contract rows with `type: \"instance\"` or `\"volume\"`.\n- `tree` serverless contracts are collapsed under endpoint/workergroup wrappers with `type: \"serverless\"` and `source: \"endpoint-<id>\"` / `\"workergroup-<id>\"`. Regular instances and volumes are unchanged.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["table","tree"]}}},{"name":"latest_first","in":"query","description":"Sort by most recent charges first.","required":false,"schema":{"type":"boolean","example":""}},{"name":"limit","in":"query","description":"Max results per page. Server maximum 500.","required":false,"schema":{"type":"number","example":""}},{"name":"select_filters","in":"query","description":"**`day`** (required). Date range in unix seconds (UTC). Operators: `gte`, `lte`.\n\n**`type`** (optional). Filter by contract type: `instance`, `volume`, `serverless`. Operator: `in`.\n\n**Examples**:\n```json\n// All charges in January 2026\n{\"day\":{\"gte\":1767225600,\"lte\":1769903999}}\n\n// Only instance charges\n{\"day\":{\"gte\":1767225600,\"lte\":1769903999},\"type\":{\"in\":[\"instance\"]}}\n\n// Volumes and serverless only\n{\"day\":{\"gte\":1767225600,\"lte\":1769903999},\"type\":{\"in\":[\"volume\",\"serverless\"]}}\n```","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/billing","api_endpoint":"https://console.vast.ai/api/v0/charges/"},"summary":"Show Charges","description":"Shows charges per instance, including GPU, storage, and bandwidth. For invoice/payment records (Stripe top-ups, transfers, payouts), use [show invoices](/api-reference/billing/show-invoices) instead.","security":[{"bearerAuth":[]}]}},"/api/v0/users/cloud_integrations/":{"get":{"tags":["Accounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/accounts","api_endpoint":"https://console.vast.ai/api/v0/users/cloud_integrations/"},"summary":"Show Connections","description":"Retrieves the list of cloud connections associated with the authenticated user.","security":[{"bearerAuth":[]}]}},"/api/v0/instances/balance/{id}/":{"get":{"tags":["Billing"],"parameters":[{"name":"id","in":"path","description":"The ID of the instance.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/billing","api_endpoint":"https://console.vast.ai/api/v0/instances/balance/{id}/"},"summary":"Show Deposit","description":"Retrieves the deposit details for a specified instance.","security":[{"bearerAuth":[]}]}},"/api/v0/users/{user_id}/machine-earnings/":{"get":{"tags":["Billing"],"parameters":[{"name":"user_id","in":"path","description":"The ID of the user.","required":true,"schema":{"type":"number","example":""}},{"name":"eday","in":"query","description":"End day for the earnings report.","required":false,"schema":{"type":"number","example":""}},{"name":"last_days","in":"query","description":"Number of days to look back from today.","required":false,"schema":{"type":"number","example":""}},{"name":"machid","in":"query","description":"Optional machine ID to filter earnings.","required":false,"schema":{"type":"number","example":""}},{"name":"sday","in":"query","description":"Start day for the earnings report.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/billing","api_endpoint":"https://console.vast.ai/api/v0/users/{user_id}/machine-earnings/"},"summary":"Show Earnings","description":"Retrieves the earnings history for a specified time range and optionally per machine.","security":[{"bearerAuth":[]}]}},"/api/v0/instances/{instance_id}/ssh/":{"get":{"tags":["Instances"],"parameters":[{"name":"instance_id","in":"path","description":"The ID of the instance to retrieve SSH keys for.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/instances","api_endpoint":"https://console.vast.ai/api/v0/instances/{instance_id}/ssh/"},"summary":"Show Ssh-Keys","description":"Retrieves the SSH keys associated with a specific instance.","security":[{"bearerAuth":[]}]}},"/api/v1/instances/":{"get":{"tags":["Instances"],"parameters":[{"name":"after_token","in":"query","description":"Keyset pagination cursor from the previous response's `next_token`. An invalid token returns a 400 error.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Instances per page. Default 25, max 25. Values ≤ 0 are treated as 5.","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"JSON array of sort directives, e.g. `[{\"col\":\"id\",\"dir\":\"asc\"}]`. Valid `dir` values: `asc`, `desc` (anything else treated as `asc`). `id` is always appended as a tiebreaker. Invalid column returns 400.","required":false,"schema":{"type":"string","example":""}},{"name":"select_cols","in":"query","description":"JSON array of column names to return, e.g. `[\"id\",\"label\",\"actual_status\"]`. Use `[\"*\"]` for all columns (default). Unknown column names are returned as `null`.","required":false,"schema":{"type":"string","example":""}},{"name":"select_filters","in":"query","description":"JSON object of column filters. Supported operators: `eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `in`, `notin`.\nFilterable columns: `actual_status`, `gpu_name`, `verification`, `id`, `label`, and other columns stored directly on the contract record. Computed fields (e.g. `dph_total`, `num_gpus`) are not filterable and return 400.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/instances","api_endpoint":"https://console.vast.ai/api/v1/instances/"},"summary":"Show Instances","description":"Retrieve a paginated list of instances for the authenticated user.","security":[{"bearerAuth":[]}]}},"/api/v1/invoices/":{"get":{"tags":["Billing"],"parameters":[{"name":"after_token","in":"query","description":"Pass the `next_token` value from the previous response to fetch the next page of results. When the response returns `next_token: null`, there are no more pages.","required":false,"schema":{"type":"string","example":""}},{"name":"latest_first","in":"query","description":"Sort newest invoices first. If `order_by` is also set, `order_by` takes precedence.","required":false,"schema":{"type":"boolean","example":""}},{"name":"limit","in":"query","description":"Max results per page.","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort results by column. Columns: `paid_on`, `amount_cents`, `when`. Direction: `asc` or `desc` (default `desc`).\n\nExample: `[{\"col\":\"paid_on\",\"dir\":\"desc\"}]`","required":false,"schema":{"type":"string","example":""}},{"name":"select_filters","in":"query","description":"**`when`** (required). Date range in unix seconds (UTC). Operators: `gte`, `gt`, `lte`, `lt`.\n\n**`service`** (optional). Filter by payment service: `transfer`, `stripe_payments`, `bitpay`, `coinbase`, `crypto.com`, `instance_prepay`, `paypal_manual`, `wise_manual`. Operators: `eq`, `neq`, `in`, `notin`.\n\n**Examples**:\n```json\n// January 2026, all services\n{\"when\":{\"gte\":1767225600,\"lte\":1769903999}}\n\n// Only PayPal and Wise payouts\n{\"when\":{\"gte\":1767225600,\"lte\":1769903999},\"service\":{\"in\":[\"paypal_manual\",\"wise_manual\"]}}\n\n// Everything except crypto\n{\"when\":{\"gte\":1767225600,\"lte\":1769903999},\"service\":{\"notin\":[\"bitpay\",\"coinbase\",\"crypto.com\"]}}\n```","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/billing","api_endpoint":"https://console.vast.ai/api/v1/invoices/"},"summary":"Show Invoices","description":"Returns Stripe top-ups, transfers, payouts, coinbase payments, and other billing transactions. For per-instance cost breakdowns, use [show charges](/api-reference/billing/show-charges) instead.","security":[{"bearerAuth":[]}]}},"/api/v0/users/{user_id}/ipaddrs/":{"get":{"tags":["Accounts"],"parameters":[{"name":"user_id","in":"path","description":"The ID of the user whose IP address history is being retrieved.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/accounts","api_endpoint":"https://console.vast.ai/api/v0/users/{user_id}/ipaddrs/"},"summary":"Show Ipaddrs","description":"This endpoint retrieves the history of IP address accesses for the authenticated user.","security":[{"bearerAuth":[]}]}},"/api/v0/machines/":{"get":{"tags":["Machines"],"parameters":[{"name":"user_id","in":"query","description":"The ID of the user whose machines are being requested.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/machines","api_endpoint":"https://console.vast.ai/api/v0/machines/"},"summary":"Show Machines","description":"Fetches data for multiple machines associated with the authenticated user.","security":[{"bearerAuth":[]}]}},"/api/v0/subaccounts/":{"get":{"tags":["Accounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/accounts","api_endpoint":"https://console.vast.ai/api/v0/subaccounts/"},"summary":"Show Subaccounts","description":"Retrieve a list of subaccounts associated with the authenticated user's account.","security":[{"bearerAuth":[]}]}},"/api/v0/team/members/":{"get":{"tags":["Team"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/team","api_endpoint":"https://console.vast.ai/api/v0/team/members/"},"summary":"Show Team Members","description":"Retrieve a list of team members associated with the authenticated user's team.","security":[{"bearerAuth":[]}]}},"/api/v0/team/roles/{id}/":{"get":{"tags":["Accounts"],"parameters":[{"name":"id","in":"path","description":"Name of the team role","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/accounts","api_endpoint":"https://console.vast.ai/api/v0/team/roles/{id}/"},"summary":"Show Team Role","description":"Retrieve details of a specific team role by its name.","security":[{"bearerAuth":[]}]},"put":{"tags":["Team"],"parameters":[{"name":"id","in":"path","description":"ID of the role to update.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/team","api_endpoint":"https://console.vast.ai/api/v0/team/roles/{id}/"},"summary":"Update Team Role","description":"Update an existing team role with new name and permissions.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"New name for the role.","required":true},"permissions":{"type":"object","description":"JSON encoded permissions for the role.","required":true,"properties":{}}}},"example":{"name":"","permissions":{}}}}}}},"/api/v0/team/roles-full/":{"get":{"tags":["Team"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/team","api_endpoint":"https://console.vast.ai/api/v0/team/roles-full/"},"summary":"Show Team Roles","description":"Retrieve a list of all roles for a team, excluding the owner' role.","security":[{"bearerAuth":[]}]}},"/api/v0/users/current/":{"get":{"tags":["Accounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/accounts","api_endpoint":"https://console.vast.ai/api/v0/users/current/"},"summary":"Show User","description":"Retrieve information about the current authenticated user, excluding the API key.","security":[{"bearerAuth":[]}]}},"/api/v0/commands/transfer_credit/":{"put":{"tags":["Accounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/accounts","api_endpoint":"https://console.vast.ai/api/v0/commands/transfer_credit/"},"summary":"Transfer Credit","description":"Transfers specified amount of credits from the authenticated user's account to another user's account.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"amount":{"type":"number","description":"Amount of credits to transfer (must be positive)","required":true},"apikey_id":{"type":"string","description":"Optional API key identifier for audit logging"},"client_id":{"type":"string","description":"Client identifier (usually \"me\")"},"recipient":{"type":"string","description":"Email address or user ID of the recipient","required":true}}},"example":{"amount":"","apikey_id":"","client_id":"","recipient":""}}}}}},"/api/v0/machines/{machine_id}/asks/":{"delete":{"tags":["Machines"],"parameters":[{"name":"machine_id","in":"path","description":"The ID of the machine to unlist.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/machines","api_endpoint":"https://console.vast.ai/api/v0/machines/{machine_id}/asks/"},"summary":"Unlist Machine","description":"Removes all 'ask' type offer contracts for a specified machine, effectively unlisting it from being available for rent.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/v0/network_volumes/unlist/":{"post":{"tags":["Network Volumes"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/volumes","api_endpoint":"https://console.vast.ai/api/v0/network_volumes/unlist/"},"summary":"Unlist Network-Volume","description":"Unlists a network volume for rent.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"id":{"type":"number","description":"ID of network volume ask being unlisted","required":true}}},"example":{"id":""}}}}}},"/api/v0/volumes/unlist/":{"post":{"tags":["Volumes"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.vast.ai/api-reference/volumes","api_endpoint":"https://console.vast.ai/api/v0/volumes/unlist/"},"summary":"Unlist Volume","description":"Remove a volume listing from the marketplace.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"id":{"type":"number","description":"ID of the volume listing to unlist","required":true}}},"example":{"id":""}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}