Skip to main content
@abadge/sdk is the official TypeScript client for the abadge API. It wraps the /v1 REST API and exposes two clients: AbadgeUserClient for operator-scoped management and AbadgeAgentClient for agent-scoped secret access.

​
Install

​
Quick reference

​
Type exports

The SDK re-exports every domain type from @abadge/core:
Helpers:

​
What the SDK does for you

  • Builds each /v1 request with the correct shape
  • Adds the right Authorization header
  • Surfaces typed responses (no any)
  • Wraps every API error in AbadgeApiError (with code, message, hint, meta)
  • For AbadgeAgentClient: handles the keypair challenge / session exchange and refreshes the session at T-2 minutes before expiry

​
What the SDK does not do

  • Not a daemon. The SDK is a pure HTTP client. Local zero-knowledge decryption is the daemon’s job.
  • Not a CLI. For human operator workflows, use the dashboard or the abadge CLI.

​
Where to go next

AbadgeUserClient

Session-scoped client for organizations, profiles, items, agents, permissions, audit.

AbadgeAgentClient

Agent-scoped client for access.* with Ed25519 keypair sessions.

Error handling

AbadgeApiError shape, common codes, retry strategy.

Errors reference

Every error code with HTTP status and remediation.

Examples

Runnable SDK examples: store & grant, agent read, keypair enrollment.