OpenAgentIDDocumentation
HTTP and API guides
OpenAgentIDAPI reference

HTTP and API guides

Choose the published API for identity, rendering, OIDC or an optional integration.

Start with the API that owns the operation. OpenAgentID does not expose one universal hosted identity/key CRUD service.

OperationPublished APIGuide
Persist a local identity and approve a peer@openagentid/sdk/local 0.7.2Local identity
Verify a signed possession/delegation proofIdentityVerifier, createIdentityVerificationHandler in SDK 0.7.2Verification
Render a stateless character or SVG@openagentid/sdk/character-api 0.7.2Character HTTP API
Sign an agent into a registered relying party@openagentid/oidc 0.2.0OIDC provider
Verify signed evidence before scoringVerifiedOatsScorer in SDK 0.7.2OATS
Verify an ACT or evaluate a skill policySeparate capability and policy APIsRunnable examples

Request formats are specific to the API

The identity handler accepts {token, delegations} at the HTTPS POST route selected by your application. Its host supplies the expected audience and a receiver-issued nonce resolver. It does not register an identity or grant application permissions.

The character handler's default base is /v1/characters; catalogs, descriptors, SVG and the OpenAPI document are public rendering data. The hosted OpenAPI document describes that rendering service only.

The OIDC provider serves its configured issuer's discovery, JWKS, authorization, token and UserInfo endpoints. Client registration, custody, consent and durable storage belong to the issuer's host.

Optional and older integrations

The published HTTP adapter 0.1.1 has a different challenge/session protocol and specific implementation limits. Its opaque sessions are not the current SDK possession proof. Arsenal has a separately configured broker client; installing a client does not provision a broker service.

Use the published package reference for exact export paths and declarations. Package publication, compatible dependencies and a running configured service are separate requirements. The standalone server migration page directs older deployments to the appropriate current contract.

On this page