@agentmatrix.pro/management-sdk
v0.1.0
Published
TypeScript SDK for AgentMatrix tenant management APIs.
Downloads
240
Maintainers
Readme
AgentMatrix Management SDK
Typed enterprise Tenant Management SDK for AgentMatrix.
npm install @agentmatrix.pro/management-sdkStable release: 0.1.0, generated against Tenant Management OpenAPI contract
0.7.0.
CONTRACT_VERSION is the Tenant Management document version. The HTTP
x-agentmatrix-api-version header is still the shared platform-v1 transport
version until the platform adds a dedicated Tenant Management negotiation
header.
Use @agentmatrix.pro/management-sdk with an agm_mgmt_* API key for
tenant-scoped automation:
- member list/create
- namespace create/list/update
- tenant-management API key issue/list/revoke
- LLM provider credential create/list/get/delete and credential-scoped model option listing
Use @agentmatrix.pro/sdk for API-key data-plane workflows such as sessions, events,
Volume, AgentSpec/EnvironmentSpec, and GET /v1/llm-provider-credentials
session credential discovery.
import { AgentMatrixManagement } from "@agentmatrix.pro/management-sdk";
const management = new AgentMatrixManagement({
apiKey: "agm_mgmt_...",
baseURL: process.env.AGENTMATRIX_BASE_URL!,
});
const keys = await management.apiKeys.list();The package does not include UserJWT /v1/auth/* or /v1/users/me/* flows,
staff /v1/admin/* endpoints, platform plan-tier administration, global audit
views, or platform model catalog mutation.
The package owns its client and resource wrappers under src/, while reusing
only package-neutral transport primitives from the repository's
internal/sdk-core directory. Builds bundle those primitives, so the published
package is self-contained and does not depend on @agentmatrix.pro/sdk.
await management.members.create({
email: "[email protected]",
password: "temporary-password",
role: "admin",
});For newly added management endpoints that do not have typed wrappers yet, use
the low-level request escape hatch. The escape hatch is intentionally restricted
to /v1/tenant/* paths:
const result = await management.request({
method: "GET",
path: "/v1/tenant/api-keys",
});When using both @agentmatrix.pro/sdk and @agentmatrix.pro/management-sdk in the same
app, prefer isAgentMatrixError(err) / isHasOpenTurnError(err) over
cross-package instanceof APIError checks. The two packages bundle their own
copy of the error classes; the helper functions use a global symbol marker and
work across packages.
