Get an Agent

Retrieve detailed information about a specific agent. The response includes GPU inventory, last heartbeat, status, version, deployment state, and the parent node binding.

Endpoint

GET /v1/agents/:id Authorization: Bearer API key required.

Path parameters

string

required

Agent identifier, e.g. ag_7f8e9d0c.

Response

string

required

Agent identifier.

string

required

Agent name.

integer

Total number of GPUs.

number

Total GPU memory in GB.

array of strings

Scheduling labels.

array

Per-GPU details: index, model, mem_total_gb, mem_used_gb, slots, used_slots.

string (ISO 8601)

Last heartbeat timestamp.

string

Agent status, e.g. online.

string

Parent GPU node identifier.

string

Agent binary version.

string

Deployment state, e.g. deployed or updating.

string

Last deployment or operation error, if any.

string

Unique deployment UID on the host.

Example

curl -s http://<pin-host>:8001/v1/agents/ag_7f8e9d0c \
  -H "Authorization: Bearer $ARIA_PIN_KEY"

{
  "id": "ag_7f8e9d0c",
  "name": "training-agent",
  "gpu_count": 8,
  "gpu_mem_gb": 640,
  "labels": ["training", "a100"],
  "gpus": [
    {
      "index": 0,
      "model": "NVIDIA A100",
      "mem_total_gb": 80,
      "mem_used_gb": 12.5,
      "slots": 1,
      "used_slots": 1
    }
  ],
  "last_heartbeat": "2024-05-10T14:30:00Z",
  "status": "online",
  "node_id": "gn_a1b2c3d4",
  "version": "1.2.0",
  "deploy_state": "deployed",
  "last_error": "",
  "agent_uid": "aria-agent-7f8e9d0c"
}

Retrieve detailed information about a specific agent. The response includes GPU inventory, last heartbeat, status, version, deployment state, and the parent node binding.

Endpoint

GET /v1/agents/:id Authorization: Bearer API key required.

Path parameters

string

required

Agent identifier, e.g. ag_7f8e9d0c.

Response

string

required

Agent identifier.

string

required

Agent name.

integer

Total number of GPUs.

number

Total GPU memory in GB.

array of strings

Scheduling labels.

array

Per-GPU details: index, model, mem_total_gb, mem_used_gb, slots, used_slots.

string (ISO 8601)

Last heartbeat timestamp.

string

Agent status, e.g. online.

string

Parent GPU node identifier.

string

Agent binary version.

string

Deployment state, e.g. deployed or updating.

string

Last deployment or operation error, if any.

string

Unique deployment UID on the host.

Example

curl -s http://<pin-host>:8001/v1/agents/ag_7f8e9d0c \
  -H "Authorization: Bearer $ARIA_PIN_KEY"

{
  "id": "ag_7f8e9d0c",
  "name": "training-agent",
  "gpu_count": 8,
  "gpu_mem_gb": 640,
  "labels": ["training", "a100"],
  "gpus": [
    {
      "index": 0,
      "model": "NVIDIA A100",
      "mem_total_gb": 80,
      "mem_used_gb": 12.5,
      "slots": 1,
      "used_slots": 1
    }
  ],
  "last_heartbeat": "2024-05-10T14:30:00Z",
  "status": "online",
  "node_id": "gn_a1b2c3d4",
  "version": "1.2.0",
  "deploy_state": "deployed",
  "last_error": "",
  "agent_uid": "aria-agent-7f8e9d0c"
}

PIN API

ROUTER API

AGENT API

Endpoint

Path parameters

Response

Example

Endpoint

Path parameters

Response

Example

​Endpoint

​Path parameters

​Response

​Example

​Endpoint

​Path parameters

​Response

​Example

Endpoint

Path parameters

Response

Example

Endpoint

Path parameters

Response

Example