Developers
Account endpoints
Agent API v1 endpoints for the account behind an API key — profile and scopes, workspaces, credit balance and usage.
These endpoints work with any valid key, whatever its scopes, and only return information about the key's own member and workspaces.
Account#
Who the key belongs to, its workspaces, credits and usage.
Get the current user#
/meThe user the API key belongs to, their plan and the key's scopes.
curl "https://api.desyn.app/api/v1/me" \
-H "Authorization: Bearer $DESYN_API_KEY"{
"userId": "u1s2e3r4i5d6",
"name": "Ada Park",
"email": "ada@example.org",
"plan": "pro",
"workspaceId": "j57a1b2c3d4e5f6g7h8i9j0k1m",
"scopes": [
"designs:read",
"designs:write",
"ai:run"
]
}List workspaces#
/workspacesWorkspaces the user belongs to, with their role in each.
curl "https://api.desyn.app/api/v1/workspaces" \
-H "Authorization: Bearer $DESYN_API_KEY"{
"items": [
{
"id": "j57a1b2c3d4e5f6g7h8i9j0k1m",
"name": "Sunline studio",
"role": "owner"
}
]
}Get credit balance#
/creditsCredits for the current period: the monthly grant, what has been used, what is reserved by running jobs, usage past the pool (overage, never billed) and whether requests are currently soft-throttled. On self-hosted installations granted and remaining are null (unlimited).
curl "https://api.desyn.app/api/v1/credits" \
-H "Authorization: Bearer $DESYN_API_KEY"{
"period": "2026-10",
"plan": "pro",
"granted": 600,
"used": 212,
"reserved": 3,
"overage": 0,
"remaining": 385,
"throttled": false
}Get usage#
/usageCounters for the current period against your plan's limits.
curl "https://api.desyn.app/api/v1/usage" \
-H "Authorization: Bearer $DESYN_API_KEY"{
"period": "2026-10",
"designs": {
"used": 48,
"limit": null
},
"storageMb": {
"used": 1834,
"limit": 102400
},
"exports": {
"used": 131,
"limit": 5000
},
"aiRequestsToday": {
"used": 37,
"limit": 600
}
}