Platform Documentation
105 documents
clear filterDevelopment System
Separate development system for teams to build and test automations without affecting production systems, with publishing workflow to production systems.
APIANT for Builders
Overview of deployment options for APIANT, including shared Docker containers, dedicated servers, and on-premises installations for integrators and enterprises.
Module Browser
View source code for all system modules and Module API classes, with options to toggle between LZX and Java implementations.
Alert Mappings
Dev to Prod
Publishing an automation from your development sandbox to production — via the plugin as the primary path, with the editor's publish workflow as a fallback.
Community Forum
APIANT's community forum for low-priority integration questions, answered by other builders. Visit https://forum.apiant.com to post or search. For urgent issues, contact APIANT support directly.
Install the Plugin
Install the APIANT plugin into a Claude Code project. About 2 minutes from clicking Connect to Claude Code in APIANT to skills loading.
MCP Tool Catalog
The complete MCP tool catalog: 138 tools across 10 toolsets, plus 11 apiant-docs tools. Core tools carry a DEV/PROD toggle.
Module Definition
Drag-and-drop interface for designing module inputs and controls that appear in the assembly editor, with preview functionality and named components for implementation access.
Setup
Walkthrough for installing, updating, or repairing the APIANT plugin via the apiant-cli.
The Four Core Objects
Automations, assemblies, connectors, and integration suites — the four building blocks every APIANT user encounters.
How Data Flows
How a trigger fires, how actions run, how data is mapped between them, and how state is persisted across executions.
Module Description
Write catalog descriptions for modules and link sample assemblies by including sample syntax in the description field to provide users with runnable examples.
Development Server
Separate development server for teams to build and test automations without affecting production systems, with publishing workflow to production servers.
Hello World
Build your first automation in 5–10 minutes: a webhook that receives a POST, transforms the body, and stores the result. Zero credentials required.
Build
Create new automations, assemblies, integration suites, and forms from natural-language prompts.
Automations
Skills Index
Every skill the APIANT plugin exposes to Claude Code, grouped by workflow. Claude picks the right one from your prompt — you rarely type the slash command.
Deploying to Customers
Distributing an automation template to customer accounts — linked deployment via the plugin, with the editor's template-admin UX as a fallback.
Field Mappings
How data is mapped between triggers and actions, with rules for scoping and defaults.
Batch Jobs
Connectors
What a connector is, how auth methods differ (OAuth V2, API Key, None), and how credentials are scoped.
Module Implementation
Edit and compile JavaScript and Java implementations for modules using the built-in code editor, with optional debug mode to trace execution and test in the assembly editor.
How Things Get Built
The two ways to construct things on APIANT — the Claude Code plugin (primary) and the visual editors (fallback) — and when to use each.
Monitoring
Watching production automations for errors, latency, and unusual behavior — via the plugin as the primary path.
Edit
Modify live automations and assemblies safely — add steps, swap apps, change endpoints, rename settings.
API Authentication
How APIANT handles authentication for external services. Most integrators use API keys — a few minutes to set up, no developer portal spelunking. OAuth is the advanced case.
Troubleshooting
Diagnosing why an automation failed and applying a fix — via the plugin, which searches execution history and proposes remediation.
Module Properties
Configuration options for browser-based visual modules that control their appearance and behavior within the APIANT platform interface.
Data Storage
How automations keep state across runs — APIANT's built-in lookup-table storage and what it's for.
Glossary
Alphabetical lookup for every APIANT platform term — concepts, object types, UI labels, and jargon.
Sandbox Basics
What your sandbox has and does not have, how to reset, and how to troubleshoot plugin installation failures.
Catalog Categories
Test & Deploy
End-to-end validation, branch coverage, failure diagnosis, and dev-to-prod publication.
Integration Suites
A collection of automations deployed together, sharing state and coordinating across workflows — the unit customers install when they buy a multi-step integration product.
Automation Patterns
Reusable automation patterns — chat widgets, CSV field mapping, error handling, and more.
Alerts
Controlling automation failure behavior — retry strategy, alert suppression, 401 carve-outs, and custom alert text.
Tenants and Linked Accounts
Multi-tenant architecture allowing a single server to host multiple isolated organizations with separate databases and user accounts, plus the ability to link child accounts to parent accounts within a tenant.
Hazelcast Dashboard
Module Settings
Design module settings using a drag-drop interface to control behavior without adding complexity to the module's interface or wiring data inputs.
Multi-Account Operations
Running APIANT for many customer accounts — account-level isolation, linked accounts for multi-location, shared credentials, and admin keyvault.
JSP Scripts
Memory Usage
Closed-Loop Learning
How Claude gets better at building APIANT automations — patterns extracted from successful builds, autonomous test-fix loops, and live diagnosis and repair.
Ops & Support
Monitor production automations, diagnose failures, and control alert behavior.
Multiple Tenants
Tenants and Linked Accounts
Multi-tenant architecture allowing a single server to host multiple isolated organizations with separate databases and user accounts, plus the ability to link child accounts to parent accounts within a tenant.
Protocol Threads
Chat Widget
AI-powered chat widget automations — from simple chatbots to multi-goal conversations with tool calling.
New Item Polling
Poll an endpoint on a schedule and fire when a new record appears. The workhorse trigger.
Pattern Library
Auto-extracted reusable patterns from real automation builds — deduped, scored, and refined weekly.
Retries
Embed Inline
Embed APIANT Inline in your page: backend-issued link token for end-user identity, install automation bundles by folder name, manage automation state.
System Keyvault
System License
System Settings
System Upgrade
Tenants
User Accounts
User Activity
User Roles
Web Services
CSV Field Mapping
Import field mappings from a spreadsheet — fuzzy-match CSV columns to real API fields.
Autonomous Build-Test-Fix
The build loop: construct, execute in test mode, inspect results, diagnose, repair, retest — until it passes.
Webhooks
New or Updated Polling
Poll and fire when a record is created or modified. Tracks last-seen cursor automatically.
Supported functionality
APIANT Inline capabilities: domain-locked embed, backend-issued end-user identity, install automation bundles by folder name, theming, automation state management.
Work Queue
Diagnosis & Repair
Live-automation failures: pull the execution trace, identify the failure mode, propose or apply a fix.
Manual Webhook
You paste a URL into the source app. Incoming invocations fire the automation.
Error Handling
Retry, suppress, rewrite, or branch — how automations respond when an action fails.
Execute Automation
Parent/child automation chaining — hub-and-spoke, sequential pipelines, cross-account dispatch.
Self-Registering Webhook
APIANT creates and tears down the webhook automatically via the target app's API. Zero manual setup.
Forms
Capture human input via a web form — as a trigger that starts an automation, or mid-flow to pause and resume.
Tenancy and Linked Accounts
How APIANT isolates customers via tenants and supports multi-location customer deployments.
Service Webhook
Credential-based webhook URL with event filtering. Multiple event types route on a single endpoint.
Invoke
A catch-all for non-CRUD patterns (e.g. sending an email, geocoding, payment auth).
Shared App Connections
Sharing one connection from a parent account across all of a multi-location customer's linked child accounts — keeps config simple and applies one rate-limit budget across every location.
Credentials
How APIANT stores and resolves credentials at user, connector, and tenant scopes.
Unary Protocol Thread Webhook
For apps that send every webhook for every customer to a single URL — the platform splits the firehose by customer and event type.
Human Moderation
Pause an automation until a person approves or denies via a moderation queue link.
Keyvalue Storage
Persistent key/value storage between runs — for dedup keys, counters, cross-system ID maps, and caches.
Latches (Fan-Out / Fan-In)
Launch N child automations in parallel, block until all finish — the fan-out/fan-in pattern.
Get Started
Install the Claude Code plugin, build your first integration in minutes, and learn how to operate the APIANT sandbox end-to-end.
App Connectors
What a connector is, the auth flavors (OAuth, API key, no credentials), and how to register an OAuth app with a vendor.
Assembly Triggers
Every way an APIANT automation can start a run — polling and webhooks.
Subroutines
Reusable sub-flows with formal input/output fields — synchronous, same-account, returns data.
Two-Way Sync
Paired triggers and actions with loop prevention and last-write-wins semantics.
Understanding APIANT
The mental model behind APIANT — the four core objects, how data flows through them, and how they are built from lower-level pieces.
Building with the Plugin
How to build automations, assemblies, and integrations on APIANT with Claude Code as the driver.
Operating in Production
What comes after "it works on dev" — moving to production, onboarding customers, monitoring, and keeping automations healthy.
APIANT Inline
APIANT Inline lets a host page install prebuilt automation bundles into an end-user's APIANT account directly from the host's UI, without sending the user to APIANT's full editor.
Admin Console
Reference
MCP tool catalog, skills index, connector setup notes, release notes, and advanced reference material.