Frontline Public API
Use the Frontline Public API to connect agents, workflows, analytics, and external systems through supported programmatic access.
Check which workspace behavior, access rule, credential, usage signal, or data-model surface the control changes.
What the Public API enables
Use the Frontline Public API to connect agents, workflows, analytics, and external systems.
The API enables programmatic access to assistants, flows/workflows, billing/usage, and analytics where those resources are supported.
Common use cases
Use the Public API to sync an external system with agents or workflows, pull operational analytics, review billing/usage, or automate reporting where the endpoint exists.
Do not use it to replace a simple action inside one workflow. For that, API Call, Outgoing Webhook, or a Studio integration is usually the better fit.
When to use it
Use the Public API when another system needs to read, coordinate, or report on Frontline resources without relying on a person clicking through the product UI.
For an action inside a specific workflow run, start with Studio Integrations, API Call, or Outgoing Webhook. For account-level programmatic access or supported resource reference, use the Public API.
Where to find endpoint details
Academy keeps this page high-level and practical. It should not duplicate the full Redocly reference.
For endpoint paths, authentication, parameters, response shapes, and request examples, open the public API docs: https://frontline-public-api.redocly.app/api.
Use the CLI for terminal workflows
For repeatable scripts, profile switching, JSON-friendly output, or Max terminal workflows, use the public npm package @getfrontline/cli: https://www.npmjs.com/package/@getfrontline/cli/.
The package installs frontline for Public API work and max for Max chat/admin commands. Use Bring your own Agent for personal API keys when connecting external AI agents.
Production checklist
Before launch, confirm the credential owner, permission scope, storage location, rotation plan, rate limits, error handling, and whether failures are visible to the operating team.
Treat API keys as production credentials. Name them by purpose, rotate them when access changes, and delete unused keys.
Transcript
Open searchable transcript
FAQs
Should Academy duplicate the API reference?
No. Academy should explain the practical integration pattern and direct developers to Redocly for endpoint-level reference details.
What can developers connect with the Public API?
Use the Public API for supported access to assistants, flows/workflows, billing/usage, analytics, and external systems.
Where should API credentials be managed?
Use Admin Developer for account API keys and request-validation secrets, then store credentials in the approved implementation environment.
Is there a public CLI?
Yes. Use @getfrontline/cli on npm for frontline Public API commands and max terminal workflows.