Integration Quickstarts
Connect RGL8R to your automation platform, CI/CD pipeline, or AI agent workflow.
Prerequisites (all quickstarts):
- An active RGL8R tenant with at least one integration key (create via
POST /api/integration-keysor Admin UI) - Your API base URL (e.g.,
https://api.rgl8r.comor staging equivalent)
Quickstart Guides
| Platform | Guide | Best For |
|---|---|---|
| n8n | n8n Quickstart | Self-hosted workflows with polling loops, branching, and error handling |
| Zapier | Zapier Quickstart | Simple trigger→action automations; limited polling support |
| CLI | CLI Quickstart | CI/CD pipelines, scripted uploads, DevOps automation |
Companion Docs
| Doc | Purpose |
|---|---|
| Agent Integration Kit | Canonical 4-step flow (auth → enqueue → poll → fetch) with curl examples |
| Public API Contract | Stable contract: auth modes, job lifecycle, idempotency, error taxonomy, quotas |
| OpenAPI Spec | Machine-readable endpoint definitions |
Choosing a Platform
Need polling loops and branching? Use n8n or the CLI. Both support the full poll-until-complete pattern natively.
Simple notification on upload? Use Zapier with a single webhook action. For job completion triggers, wait for P12-B (async webhook callbacks) which will eliminate polling entirely.
CI/CD or scripted workflows? Use the CLI (@rgl8r/integration-cli). It handles auth, upload, PII sanitization, and exit codes for pipeline integration.
AI agent integration? Start with the Agent Integration Kit which covers the canonical flow. See also llms.txt for AI-discoverable platform description.
Channel-specific AI playbooks are maintained in the internal docs surface and are intentionally excluded from the public docs bundle.
Plan ID: P12-A | Last updated: 2026-02-25