Skip to content
agentsub
Esc
↑↓navigate↵open⌘Jpreview

Owner dashboard overview

GET/v1/owner/overview
Authorization
AuthorizationBearer token (JWT) · headerrequired

Clerk human owner session JWT; iss must equal the configured Clerk issuer and the identity must be a human (not agent) owner with a verified email.

or
AuthorizationBearer token (JWT) · headerrequired

Backend-verified Clerk AgentID social session, own-agent read/service actions only

or
AuthorizationOAuth2 access token · headerrequired
Scopes:agentsub:owner
Responses
200

Humans see their workspace; AgentID social Clerk sessions see only their own agent and activity

modestring
storagestring
ownerOwnerRef
Show properties
idstring
emailstring<email>
namestring
actorTypestring
Allowed:humanagent
agentsAgentWithBalance[]
Show properties
Array of AgentWithBalance
idstring
ownerIdstring
namestring
statusstring
Allowed:activefrozen
capsAgentCaps
Show properties
perTxMaxUcMicrocredits

Integer microcredits as a decimal string. 1 credit = 1,000,000 microcredits = $0.01 USD.

matches ^[0-9]+$
dailyMaxUcMicrocredits

Integer microcredits as a decimal string. 1 credit = 1,000,000 microcredits = $0.01 USD.

matches ^[0-9]+$
monthlyMaxUcMicrocredits

Integer microcredits as a decimal string. 1 credit = 1,000,000 microcredits = $0.01 USD.

matches ^[0-9]+$
allowedAcceptorsstring[]
allowedCategoriesstring[]
profileAgentProfile
Show properties
namestring
presetstring
Allowed:letterringsmosaicgradient
colorstring
balanceBalance
Show properties
availableUcMicrocreditsrequired

Integer microcredits as a decimal string. 1 credit = 1,000,000 microcredits = $0.01 USD.

matches ^[0-9]+$
heldUcMicrocreditsrequired

Integer microcredits as a decimal string. 1 credit = 1,000,000 microcredits = $0.01 USD.

matches ^[0-9]+$
spentUcMicrocreditsrequired

Integer microcredits as a decimal string. 1 credit = 1,000,000 microcredits = $0.01 USD.

matches ^[0-9]+$
lotsobject[]
balanceBalance
Show properties
availableUcMicrocreditsrequired

Integer microcredits as a decimal string. 1 credit = 1,000,000 microcredits = $0.01 USD.

matches ^[0-9]+$
heldUcMicrocreditsrequired

Integer microcredits as a decimal string. 1 credit = 1,000,000 microcredits = $0.01 USD.

matches ^[0-9]+$
spentUcMicrocreditsrequired

Integer microcredits as a decimal string. 1 credit = 1,000,000 microcredits = $0.01 USD.

matches ^[0-9]+$
lotsobject[]
offersOffer[]
Show properties
Array of Offer
idstring
acceptorIdstring
titlestring
descriptionstring
unitstring
priceUcMicrocredits

Integer microcredits as a decimal string. 1 credit = 1,000,000 microcredits = $0.01 USD.

matches ^[0-9]+$
priceUsdstring

USD decimal string; 1,000,000 microcredits = $0.01

categorystring
acceptedPaymentMethodsstring[]
activityobject[]
Show properties
Array of object
idstring
agentIdstring
offerIdstring
amountUcMicrocredits

Integer microcredits as a decimal string. 1 credit = 1,000,000 microcredits = $0.01 USD.

matches ^[0-9]+$
atinteger
typestring
approvalsobject[]
401

unauthorized problem; live 401s advertise WWW-Authenticate: Bearer resource_metadata=...

typestringrequired
titlestringrequired
statusintegerrequired
codestringrequired
403

Identity, ownership, scope or policy denied (human_required, owner_claim_required, scope_required, FROZEN, CAP_EXCEEDED, SCOPE_FORBIDDEN)

typestringrequired
titlestringrequired
statusintegerrequired
codestringrequired
503

Runtime or provider configuration unavailable (runtime_configuration_required, signing_configuration_required, runtime_unavailable, workspace_unavailable, provider_configuration_required)

typestringrequired
titlestringrequired
statusintegerrequired
codestringrequired
Request
curl -X GET 'https://api.agentsub.dev/v1/owner/overview' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "mode": "live",
  "storage": "convex",
  "owner": {
    "id": "string",
    "email": "user@example.com",
    "name": "string",
    "actorType": "human"
  },
  "agents": [
    {
      "id": "string",
      "ownerId": "string",
      "name": "string",
      "status": "active",
      "caps": {
        "perTxMaxUc": "string",
        "dailyMaxUc": "string",
        "monthlyMaxUc": "string",
        "allowedAcceptors": [
          "string"
        ],
        "allowedCategories": [
          "string"
        ]
      },
      "profile": {
        "name": "string",
        "preset": "letter",
        "color": "string"
      },
      "balance": {
        "availableUc": "string",
        "heldUc": "string",
        "spentUc": "string",
        "lots": [
          {}
        ]
      }
    }
  ],
  "balance": {
    "availableUc": "string",
    "heldUc": "string",
    "spentUc": "string",
    "lots": [
      {}
    ]
  },
  "offers": [
    {
      "id": "string",
      "acceptorId": "string",
      "title": "string",
      "description": "string",
      "unit": "string",
      "priceUc": "string",
      "priceUsd": "string",
      "category": "string",
      "acceptedPaymentMethods": [
        "string"
      ]
    }
  ],
  "activity": [
    {
      "id": "string",
      "agentId": "string",
      "offerId": "string",
      "amountUc": "string",
      "at": 0,
      "type": "string"
    }
  ],
  "approvals": [
    {}
  ]
}