Punk Documentation
Punk is the adaptive runtime for production AI agents. These public docs are for customers evaluating, integrating, administering, and operating Punk.
Start Here
| Reader | Start with | Then read |
|---|---|---|
| Evaluating Punk | Onboarding | Onboarding Guide, Chorus |
| Chat user or tester | Onboarding | Chat & Agents |
| Workflow builder | Onboarding | Onboarding Guide, Workflows |
| App developer | Onboarding | SDK, API, Workflows, Chat & Agents |
| Platform operator | Onboarding | Onboarding Guide, Configuration, Billing & Usage, Troubleshooting |
| Pantasso operator | Pantasso Integration | Operations, Configuration, API |
| Security or GRC reviewer | Onboarding Guide | Governance, API, Configuration |
| Team admin | Accounts & Orgs | Billing & Usage, Governance |
Documentation Map
- Onboarding: 30-minute local paths for evaluators, workflow builders, app developers, and operators.
- Onboarding Guide: extended pilot and rollout guide from workflow selection through production readiness.
- SDK: TypeScript client reference for chat, tools, feedback, web fetch, sessions, and admin reads.
- API: HTTP endpoints, auth, identity headers, and response conventions.
- Workflows: workflow builder, node configuration, scheduling, credentials, templates, and endpoints.
- Chat & Agents: conversations with visible route economics, save-as-agent, and scheduled single-task agents.
- Chorus:
model: "punk/chorus"governed intelligence route, request controls, evidence receipts, SDK helpers, and governance posture. - Configuration: environment variables, gateway modes, auth, databases, and tenant settings.
- Operations: persistent runtime operations, workers, health/readiness, backups, and deployment notes.
- DigitalOcean Deployment: Droplet-oriented systemd deployment kit.
- Pantasso Integration: how Punk and Pantasso stay separate while Punk governs Pantasso agent runtime calls.
- Governance: policies, trust tiers, side-effect levels, approvals, observe mode, and audit.
- Accounts & Orgs: user accounts, multi-org switcher, invitations, public signup, and email configuration.
- Billing & Usage: plans, quotas, per-tenant usage metering, the usage API, and optional Stripe setup.
- Troubleshooting: common setup, routing, provider, workflow, governance, and billing symptoms.
- What's New: user-facing release notes.
What Customers Can Do
- Route OpenAI-compatible traffic through
/v1/chat/completions. - Route Anthropic-compatible traffic through
/v1/messages. - Use Chorus with
model: "punk/chorus"for governed, receipt-backed work. - Build workflows in the dashboard, run them on demand, or schedule them by cron.
- Turn a useful chat into a reusable agent.
- Add identity headers so cost, policy, and audit records stay attributable.
- Configure policies, approvals, redaction, tripwires, and tenant settings.
- Invite teammates, manage organizations, issue tenant API keys, and review usage.
- Track cost, savings, blocked actions, and route explanations from the dashboard and API.
Public Documentation Policy
Keep these pages focused on setup, integration, operation, security review, billing, troubleshooting, and customer-visible behavior.