zinn-agents

GET /v1/agents/{agentId}/memory

The agent's "+1 GB memory" add-on — what counts now, the price per GB, how many more.

All zinn-agents endpoints

All developer docs →

Authentication

Send an API key as a bearer token. The endpoint checks agents.view; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/agents/{agentId}/memory \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

plan_mb is the plan's memory; addon_gb the add-on GB that count today (an add-on counts while it is paid: a refunded, stopped-and-expired or unpaid-renewal-paused one does not); effective_mb = plan + add-on (the pod's guaranteed REQUEST) and limit_mb twice it (the burst limit); applied_addon_mb what the running pod was last started with. unit_price is ONE GB per month in the caller's currency (integer minor units). offered is false while the add-on's launch switch is off for this organisation. docs/1047 §13.

Parameters

NameTypeRequiredWhat it is
agentId (path)stringYes—
currency (query)stringNoThe currency to price unit_price in (as on the agents list).

Response

NameTypeRequiredWhat it is
plan_mbintegerYes—
addon_gbintegerYesAdd-on GB that count today.
effective_mbintegerYesPlan + add-on — the pod's guaranteed request.
applied_addon_mbintegerYesAdd-on MiB the running pod was started with.
limit_mbintegerYesThe burst limit (twice effective_mb).
max_more_gbintegerYes—
offeredbooleanYes—
unit_priceobjectYes—
addonsAgentMemoryAddon[]Yes—

Errors this endpoint can return

401 · 404