OpenAgentID documentation
Source referencesPackage entries

@openagentid/sdk (TypeScript)

OpenAgent SDK — Clerk for autonomous agents. One import for identity, credentials, and verification.

Purpose

OpenAgent SDK — Clerk for autonomous agents. One import for identity, credentials, and verification.

Read the unified sdks guide.

Source contract

FieldValue
Package@openagentid/sdk
Version0.1.1
LanguageTypeScript
Runtime floor{'node': '>=20'}
Manifestopenagent-sdk/sdks/typescript/package.json
DistributionSource package; registry publication not verified

Manifest SHA-256: c165566f43c808245f1550261853a428435c82e96b30e38c7feafdb0ad486f79. The recorded Git revision identifies the containing repository; the manifest and entry-point hashes identify this working-tree snapshot.

Integration

Use the package root above from an authorized source checkout. Preserve sibling dependencies and their version/feature requirements. Install the runtime and compile the selected package before using its generated artifacts. The task guide describes configuration, trust boundaries, and error behavior. Test/conformance and deployment packages are supporting tools, not interchangeable production identity providers.

Declared package subpaths

{
  ".": {
    "types": "./dist/index.d.ts",
    "import": "./dist/index.js",
    "require": "./dist/index.cjs"
  },
  "./agent": {
    "types": "./dist/agent.d.ts",
    "import": "./dist/agent.js",
    "require": "./dist/agent.cjs"
  },
  "./identity": {
    "types": "./dist/identity.d.ts",
    "import": "./dist/identity.js",
    "require": "./dist/identity.cjs"
  },
  "./credentials": {
    "types": "./dist/credentials.d.ts",
    "import": "./dist/credentials.js",
    "require": "./dist/credentials.cjs"
  },
  "./verification": {
    "types": "./dist/verification.d.ts",
    "import": "./dist/verification.js",
    "require": "./dist/verification.cjs"
  },
  "./skills": {
    "types": "./dist/skills.d.ts",
    "import": "./dist/skills.js",
    "require": "./dist/skills.cjs"
  },
  "./errors": {
    "types": "./dist/errors.d.ts",
    "import": "./dist/errors.js",
    "require": "./dist/errors.cjs"
  }
}

Exported entry points

The declarations below are extracted from the named entry files. This is a navigable source reference, not compiler-generated documentation of every transitive module. Feature gates and runtime requirements still apply. Private implementation files are not promoted to public APIs merely because they contain a public declaration.

openagent-sdk/sdks/typescript/src/index.ts

Source SHA-256: 2590668b23ddcf9004fd43a485ca34610803d845804dc209f7531f64dfd13348.

export { OpenAgent, OpenAgentRuntime, type OpenAgentInstance } from './agent.js';
export {
  type OpenAgentConfig,
  type OpenAgentClients,
  type ResolvedOpenAgentConfig,
  type CreateAgentInput,
  type Logger,
  resolveConfig,
  silentLogger,
  createAgentInputSchema,
  didSchema,
  scopeSchema,
  providerSchema,
  DEFAULT_NAMESPACE,
  DEFAULT_REQUEST_TIMEOUT_MS,
  DID_REGEX,
} from './config.js';
export {
  type Did,
  type IdentityDocument,
  type IdentityProvider,
  type SignedAssertion,
  parseIdentityDocument,
  toIdentityProvider,
  identityDocumentSchema,
} from './identity.js';
export {
  type ArsenalClient,
  type CredentialHandle,
  type IssuedCredential,
  createCredentialHandle,
} from './credentials.js';
export {
  type AuthContext,
  type LineageAuthorityContext,
  type PrivilegedAuthorityVerifier,
  type VerificationClient,
  type VerifyRequestOptions,
  PrivilegedAuthorityVerificationClient,
  extractBearerToken,
  assertScopes,
  assertAncestor,
  toVerificationClient,
} from './verification.js';
export {
  type SkillId,
  type SkillsPolicy,
  InMemorySkillsPolicy,
  denyAllSkills,
  allowAllSkills,
} from './skills.js';
export {
  act,
  ActVerifierBuilder,
  setActCryptoBinding,
  type ActClaims,
  type ActVerifyOptions,
} from './act.js';
export {
  withAct,
  requireActExpress,
  type RequireActConfig,
} from './middleware.js';
export {
  keys,
  setKeyCryptoBinding,
  type AgentKeys,
  type KeyCryptoBinding,
} from './keys.js';
export {
  OpenAgentError,
  ConfigError,
  InputValidationError,
  IdentityError,
  CredentialError,
  VerificationError,
  SkillDeniedError,
  ErrorCode,
  type ErrorCodeValue,
  type ErrorDetails,
  wrapError,
  getErrorMessage,
} from './errors.js';
export const VERSION = '0.1.1';

Exported API signatures

Read resolved TypeScript exports and source documentation.

On this page