OpenapiVisor
Returns one of the caller org's machines by its org-scoped name.
Returns one of the caller org's machines by its org-scoped name.
GET /v1/visor/machines/{id}
| Address | https://api.hanzo.ai/v1/visor/machines/{id} |
| Method | GET |
| Operation | getMachine |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns one of the caller org's machines by its org-scoped name. Visor keys the lookup by owner/name, so an id belonging to another tenant resolves to not-found rather than another org's machine.
Request
1 field.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | ID is the machine's org-scoped NAME — the stable key Visor addresses a machine by (owner/name), not the ephemeral provider id. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | machineView | ok |
200 body — 14 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
createdTime | body | string | — | CreatedTime is when the machine came into being: the provider's own creation timestamp for a Visor machine, passed through in whatever form it states it, and… |
gpu | body | string | — | GPU names the accelerators this machine holds ("H100", or "2× NVIDIA GB10" for a BYO machine reporting a matched pair). |
id | body | string | — | ID addresses this machine on the /v1/visor/machines/:id routes: the org-scoped NAME Visor keys a machine by, falling back to the provider id for a machine that… |
image | body | string | — | Image is the OS image the machine booted from, as the provider names it. |
mem | body | string | — | Mem is system RAM rendered for a human ("8 GB"), not a number to compute with. |
name | body | string | — | Name is the label to show a human — Visor's displayName, or the machine name when it carries none. A BYO machine's is its hostname. |
os | body | string | — | Os is the operating system on the machine — Visor's record for a provisioned one, the host's own report (linux, darwin, windows) for a BYO one. |
privateIp | body | string | — | PrivateIp is the address on the provider's own network, reachable from the org's other machines in the same region. |
provider | body | string | — | Provider is the cloud that runs the machine ("digitalocean"), or "byo" for one the operator dialed in with hanzo link. |
publicIp | body | string | — | PublicIp is the internet-facing address the provider assigned. |
region | body | string | — | Region is the provider region slug ("sfo3"), or the zone when the provider reports only that. |
status | body | string | — | Status is the lifecycle state in the PROVIDER's own words ("active", "running", "off"), passed through rather than mapped onto a vocabulary of ours. |
type | body | string | — | Type is the provider SIZE SLUG the machine runs at ("s-2vcpu-4gb", "gpu-h100x8-640gb") — the value a launch asks for, and what Vcpu/Mem/GPU are read out of… |
vcpu | body | integer | — | Vcpu is logical cores — the provider's own cpuSize when that is a clean integer, else the count read out of the size slug (4 from "s-4vcpu-8gb"). |
Failure carries the platform error shape — see Errors.
Examples
hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.
import { Configuration, VisorApi } from 'hanzoai';
const api = new VisorApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getMachine({ id: 'id' });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import VisorApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = VisorApi(client).get_machine(id='id')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.VisorAPI.GetMachine(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, visor_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = visor_api::get_machine(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.VisorApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new VisorApi(client).getMachine();curl https://api.hanzo.ai/v1/visor/machines/<id> \
-H "Authorization: Bearer $HANZO_API_KEY"Tool visor, op getMachine — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "visor",
"arguments": {
"op": "getMachine",
"input": {
"id": "<id>"
}
}
}
}'How is this guide?