Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vast.ai/llms.txt

Use this file to discover all available pages before exploring further.

Search for template results using custom query

​
Usage

vastai search templates [--help] [--api-key API_KEY] [--raw] <query>

​
Arguments

​
query
string
required
Search query in simple query syntax (see below)

​
Description

Query syntax 
query      = comparison comparison...
comparison = field op value
field      = <name of a field>
op         = one of: <, <=, ==, !=, >=, >, in, notin
value      = <bool, int, float, string> | 'any' | [value0, value1, ...]
bool       = True | False
  • Wrap > and < in quotes on the command line
  • For string values (e.g. gpu_name), replace spaces with underscores: RTX_3090 not RTX 3090

​
Examples

vastai search templates 'count_created > 100  creator_id in [38382,48982]'

​
Available Fields

FieldTypeDescription
creator_idintID of creator
created_atfloattime of initial template creation (UTC epoch timestamp)
count_createdintnumber of instances created (popularity)
default_tagstringimage default tag
docker_login_repostringimage docker repository
idinttemplate unique ID
imagestringimage used for template
jup_directboolsupports jupyter direct
hash_idstringunique hash ID of template
namestringdisplayable name
recent_create_datefloatlast time of instance creation (UTC epoch timestamp)
recommended_disk_spacefloatmin disk space required
recommendedboolis on our recommended list
ssh_directboolsupports ssh direct
tagstringimage tag
use_sshboolsupports ssh (direct or proxy)

​
Global Options

The following options are available for all commands:
OptionDescription
--url URLServer REST API URL
--retry NRetry limit
--rawOutput machine-readable JSON
--explainVerbose explanation of API calls
--api-key KEYAPI key (defaults to ~/.config/vastai/vast_api_key)