OpenAgentIDDocumentation
API reference
OpenAgentIDAPI reference

The API. Exactly as shipped.

Find an import, inspect its signature, and build against a specific published release.

From package to application

Every entry point in the JavaScript reference comes from a pinned npm archive. Follow the import path, inspect the complete declaration, then use a runnable guide to connect it to your application.

Explore the SDK

SDK 0.7.2 · OIDC 0.2.0 · Starter 0.5.2

01 / PRIVATESignerHolds the key
02 / AUTHORITYReceiverVerifies the proof
03 / PRESENTATIONViewerShows the result
One local app. Separate responsibilities.

What are you building?

Start with code you can run

The first-agent quickstart creates a complete local application and sends a real signed request. The runnable API examples exercise character rendering, skills policy and signed ACT verification, including rejection cases. Copy a whole file and run it with its pinned dependencies.

Reference blocks labeled Signature describe the package contract; they are declarations, not standalone programs. Browser and server entry points are separate. Import from the path shown on the page.

Choose a published package

SurfaceReleaseStart here
Identity, verification and characters@openagentid/sdk@0.7.2SDK entry points
OpenID Connect provider@openagentid/oidc@0.2.0OIDC declarations
Working application generatorcreate-openagent@0.5.2CLI contract
Independently versioned componentsPer packageComplete npm catalog
Rust protocols and componentsPer crateVersioned Rust docs

Some older integrations require SDK ^0.1.0, which excludes 0.7.2. Their references state the published peer range and limitations. A published package is not automatically compatible with the current SDK. Follow the production guide before connecting a real application boundary.

Trace every declaration

The machine-readable API manifest records exact versions, archive integrity, entry points and declaration coverage. CI regenerates the reference from those archives and rejects drift. Search accepts API names such as mountCharacter; headings link directly to their declarations.

The previous source snapshots have been retired. Existing package links lead to current npm references, official versioned Rust docs, or an explicit availability notice.

On this page