Tools
Exactly what the server advertised in the scan completed . Effects and capabilities are classified by Squatch from each tool's metadata. Squatch never runs tools.
- Effect: Read 16
- Effect: Write 5
- Effect: Admin 1
Showing 22 of 22 tools
| Details | ||
|---|---|---|
| extend_deployment Add hours to the term of a deployment that is requested, queued, provisioning or running. Same machine, same SSH details; billing stays per… | Effect: Admin | |
| create_booking Send a GPU request. It is created as requested or queued and becomes running later (use wait_for_deployment); nothing is charged before it … | Effect: Write | |
| list_servers The servers a booking can name: id (the server_id of quote_booking and create_booking), GPU model, price per GPU-hour in CAD, allowed_gpu_c… | Effect: Write | |
| list_ssh_keys The SSH public keys saved on the account: a booking with no ssh_public_key uses them (not available to a sandbox key). Adding or removing k… | Effect: Write | |
| set_auto_renew Turn automatic renewal of a deployment on or off. On, it keeps running and drawing credit past its end time until it is turned off or credi… | Effect: Write | |
| stop_deployment Stop a deployment now: billing ends at this minute and its container and NVMe scratch disk are deleted and cannot be recovered. A request t… | Effect: Write | |
| check_availability One yes or no per GPU model: is it free right now. A no does not block a request; the request waits for capacity. | Effect: Read | |
| get_account The account behind the API key (email, company, type), whether the key is a sandbox key, and the prepaid balance in CAD (simulated under a … | Effect: Read | |
| get_billing The prepaid balance and the most recent credit ledger lines (top-ups and charges) in CAD. | Effect: Read | |
| get_deployment One deployment in full: state and reason, SSH host and port, the host key fingerprint to verify, rate per GPU-hour, cost so far, start and … | Effect: Read | |
| get_deployment_events The state changes of a deployment, oldest first, each with its reason, actor and time. Read this to learn why a deployment failed, ended or… | Effect: Read | |
| get_pricing List prices in CAD: GPU-hour per GPU model, object storage per GB-month, and the Models API. Use this instead of any remembered price. | Effect: Read | |
| get_service_status The public status of each service (console, API, GPU region, object storage, Models API). | Effect: Read | |
| get_storage_usage Object storage: GB stored, active keys, price per GB-month and the amount billed this month (not available to a sandbox key). | Effect: Read | |
| get_usage What the account was charged for GPU time, object storage and the Models API over a date range, in CAD before tax. Only deployments that ra… | Effect: Read | |
| list_deployments Every deployment of the account with its state, GPU count, rate, cost so far and end time. States: requested, queued, provisioning, running… | Effect: Read | |
| list_invoices The account's invoices (not available to a sandbox key). | Effect: Read | |
| list_templates The templates a booking can name: slug, name, the container image it runs, category. Without a template a deployment runs the default PyTor… | Effect: Read | |
| quote_booking What a booking would cost in CAD: GPU cost, tax and total for the whole duration, and the hourly rates. Books nothing and charges nothing. … | Effect: Read | |
| read_doc One documentation page as Markdown, by its slug (from search_docs). Read the page before answering a question about how the platform works. | Effect: Read | |
| search_docs Search the documentation by keyword. Returns the matching sections with a snippet and the slug to pass to read_doc. | Effect: Read | |
| wait_for_deployment Poll a deployment until it reaches a state (default running) or a final state, for at most 50 seconds per call. Returns reached, the curren… | Effect: Read |