Skip to main content
TruAgents publishes a single OpenAPI 3.0.3 specification that describes its public API — today, OAuth token issuance and the Unsubscribe endpoints. Generate client SDKs from it, import into Postman or Insomnia, or drive contract tests; use the linked prose guide for setup context, examples, and edge-case behavior.

Machine-readable specification

TruAgents public API

Covers POST /oauth/token and the /api/v1/unsubscribe/{email,sms,phone} operations.
Building in Python? The first-party truagents SDK wraps this spec with auto-refreshing OAuth tokens, retries, and typed exceptions — usually the fastest path from pip install to production.

Conventions

  • Location. The spec is served at /openapi/truagents.json on this docs site.
  • Version. openapi: "3.0.3".
  • One spec, growing coverage. New public operations land in this file as they ship; there is no per-domain split.
  • Prose is authoritative. The integration mdx is the canonical narrative. If the JSON drifts from the prose, treat the prose page as source of truth and report the mismatch so we can fix the spec.