OpenAgentIDDocumentation
OpenAgentIDStart building

Build your first agent.

Real identity. A signed request. A living character. Start locally with OpenAgentID.

Use these docs with your agent ↗

The recommended start

Create a working local app with real signing keys, a receiver that checks each request, and a live character in your browser.

Run your first agent

Node 20+ and npm. Free, open source, no hosted account.

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

Start with the working app

Open a terminal in the folder where you keep your projects. Copy this whole block:

Terminal 1 · Start the receiver
npx --yes create-openagent@0.5.2 my-agent-app --yes
cd my-agent-app
npm install
npm run dev

Leave that terminal running and open the printed viewer URL, normally http://127.0.0.1:3210. The starter creates the app; the quickstart's second-terminal command sends its first authenticated request.

The starter is 0.5.2 and installs @openagentid/sdk 0.7.2. Its first task echoes your message and returns its SHA-256 digest. You can add your application's work after that request succeeds.

Pick your next step

Start hereRun the complete quickstartCreate the app, send a signed request, and confirm the result in the browser.Already building?Use your existing applicationCreate a persistent identity and explicitly import its public key at your receiver.PresentationGive your agent a characterUse the browser player, real activity states and appearance controls.AuthenticationConnect your verifierBring current trust, revocation and replay storage to a real application boundary.

Keep the boundaries clear

Identity tells the receiver which key signed a request. Permission comes from your application's policy. Presentation is the character you see; its appearance proves neither identity nor completed work.

Local identity needs no central registry, blockchain or Life account. Receivers can authorize an owner chain or an explicitly trusted self root. Your keys and authority stay on your infrastructure.

When you need more, follow developer tools, the separate OpenID Connect provider, or production integration. OIDC is published as @openagentid/oidc 0.2.0 and requires Node 20.19+.

The API reference follows the actual published packages: exact entry points, signatures and compatibility notes. Search by API name or open complete runnable examples. Other language modules have independent versions and coverage.

OpenAgentID is part of the Open Software family.

Run your first agent

Start a local app, send a real signed request, and watch its character respond.

On this page

Start with the working appPick your next stepKeep the boundaries clear