API overview
Use Personal Access Tokens to connect external clients to Pegasus.
Pegasus API access lets external clients authenticate with a Personal Access Token (PAT) and perform actions within selected scopes.
API access is available on Pro and Ultra plans. Free workspaces see an upgrade prompt instead of the token creator.
What you can use it for#
- Build an internal tool that chats with a Pegasus bot.
- Read usage analytics from another system.
- Manage bots or documents if the token has write scopes.
- Bind automation to Personal or Team workspace context.
What the docs page is not#
This user guide explains the in-app token workflow. Full public API docs and playground are planned for API Product v1.
We're actively working on this. Check back soon, or contact your workspace owner for the latest status.
A public developer docs/playground surface is on the roadmap. Until then, use this guide for token safety and workspace binding.
Core safety rule#
Treat tokens like passwords. Anyone with a token can call the API as you within its scopes.