Gateway API reference

Interactive reference for authentication, organization access, trusted agent keys, protocol verification, compliance exports, disputes, settlement settings, and Signal endpoints.

Loading…

Gateway at a glance

Gateway is the public API surface for sign-in, machine access, organization-scoped operations, protocol verification, compliance exports, and reputation workflows.

POST /v1/public/auth/login/start, POST /v1/auth/refresh, and POST /v1/auth/logout cover session lifecycle and authenticated console access.
GET /v1/auth/principal resolves the tenant and environment for hosted service-account SDK sessions.
GET /v1/admin/protocol/agent-keys, POST /protocol/v2/mandates/verify, and POST /protocol/v2/recognition/verify support trusted agent keys, mandate validation, and recognition checks.
POST /v1/compliance/audit-exports, GET /v1/compliance/ledger/verify, and GET /signal/v1/overview cover exportable evidence, ledger checks, and organization-scoped Signal data.

See Console sign-in · V2 protocol trust · Ledger and provenance

SDK usage

Excerpt from the Kit quickstarts: open an organization-scoped session through Gateway, then continue with Kit-based requests. Use the interactive reference for request and response details. TypeScript · Python

paybond-session.ts

Code exampleSwipe to inspect long lines

import { Paybond } from "@paybond/kit";

const paybond = await Paybond.open({
  apiKey: process.env.PAYBOND_API_KEY!,
  expectedEnvironment: "sandbox",
});

try {
  const instrumented = await paybond.instrument({
    policy: "./paybond.policy.yaml", // or preset id "travel"
    tools: {
      premium_search: (input) => paidProvider.search(input),
    },
    sandbox: true, // local dev: immediate sandbox runtime; omit for deferred production bind
  });
  const tools = instrumented.tools;

  // Register `tools` with your agent runtime (OpenAI, LangGraph, MCP, custom).
  // Production: omit sandbox; call instrumented.bind({ intentId, capabilityToken }) per session.
} finally {
  await paybond.aclose();
}

import { Paybond } from "@paybond/kit";

const paybond = await Paybond.open({
  apiKey: process.env.PAYBOND_API_KEY!,
  expectedEnvironment: "sandbox",
});

try {
  const instrumented = await paybond.instrument({
    policy: "./paybond.policy.yaml", // or preset id "travel"
    tools: {
      premium_search: (input) => paidProvider.search(input),
    },
    sandbox: true, // local dev: immediate sandbox runtime; omit for deferred production bind
  });
  const tools = instrumented.tools;

  // Register `tools` with your agent runtime (OpenAI, LangGraph, MCP, custom).
  // Production: omit sandbox; call instrumented.bind({ intentId, capabilityToken }) per session.
} finally {
  await paybond.aclose();
}

Need the broader API overview?

See /docs/api for shared authentication, versioning, idempotency, and error behavior across Harbor, Gateway, and Signal.