Skip to content
AON - Agent Offer Network
 

SDK implementation

Choose the SDK after trying the Public Test Sandbox when the TypeScript client library fits your application. SDKs help with language-level API shape; the canonical v1.0 contract remains the source of truth for a new protocol integration.

Use the TypeScript SDK for your application. Before a live query, the SDK is initialized with the placement id of a placement in a serviceable Application.

Use the TypeScript SDK

Get your Placement ID

Identity

The SDK sends your placement id as the X-AON-Placement-Id header on every query. SDK setup does not change account access; for the authoritative guidance, see Authentication.

Language

Local SDK verification

Use SDK mock mode only to validate client construction, request shape, and application error handling locally. Mock mode never calls the network, so it cannot establish live access.

import { initialize } from "@agentoffernetwork/sdk"
 
const client = await initialize({ placementId: "plc_A1b2C3d4E5f6G7h8", mode: "mock" })

SDK handoff boundary

Installation and local mock verification are local checks, not live completion. Complete the TypeScript route only after it is initialized with your placement id and its live query returns the canonical v1.0 success result.

To get your placement id, see Get your Placement ID and Authentication. These shared prerequisites do not choose a language for you.

For signature details, Open SDK Reference.

For a new HTTP integration, send the exact selector AON-Protocol-Version: 1.0 and validate the same Query / Offer contract before relying on SDK convenience methods. Treat the canonical v1.0 schema and generated SDK types as the Offer contract.