Documentation v1.24
Last updated 2026-08-20 Give feedback

Payrail Agent SDK

The SDK is the right entry point when you own the surrounding agent, browser, or backend runtime and need Payrail Agent as the Memory request layer.

What each part of the SDK client does

Install

Use the public package in trusted Node or TypeScript runtimes.

Shell
npm i @payrail-one/agent-sdk

Client Responsibilities

The SDK handles communication with Payrail Agent. Your app still owns browser control, provider calls, UI, and what happens after a protected result is returned. For browser fields, the host adapter supplies exact targets and Payrail Agent Fill performs only protected actuation.

  • Create workflow sessions.
  • Resolve protected field values through user-approved requests.
  • Run protected actions such as a payment authorization.
  • Ask the user to choose from runtime-provided options.
  • Create hosted links when a request or session needs to move back to a Payrail Agent-controlled UI.
  • Wait for request results without writing custom polling.

Security Rule

Treat request artifacts as short-lived handoff material. Do not log them, print them, store them in prompts, or give them to the LLM.

Payrail Agent public documentation.