Documentation map
Browse the public documentation by subject. If this is your first visit, start with Start here; for a complete practice path, choose Vue 3 or React. Reference is for exact contracts, Recipes for concrete interface tasks, and Troubleshooting starts from observable symptoms.
Project and trust
- Home
- Start here
- Live examples
- Examples and recipes index
- Security and trust center
- Releases, support matrix, and upgrades
- Governance, RFC, and community
- License and trademark
- Documentation for agents
Mission
- Why a capability layer
- What Pling is, and is not
- Trust, authority, and audit
- From single-site bridge to open protocol
Shared concepts
- How Pling works
- The page capability model
- What the agent can see
- Execution lifecycle
- Approval and human handoff
- Sensitive data and trust boundaries
- How one agent run works
- Connecting external agents
- Model access and trust boundaries
- Diagnostics and observability
- Failure model and error codes
- Versioning and compatibility
- Task continuity across pages and tabs
- Projection: Shadow DOM and iframes
Operations
- Add the assistant UI
- Theme, locale, and accessibility
- Connect a model gateway
- Deploy to production
- Test and debug capabilities
- Expose capabilities to external agents
- Upgrade Pling safely
Vue 3
- Vue 3 learning path
- Installation and model configuration
- Quick start: a complete Todo agent
- Inspect one agent run
- Actions with input and verified results
- Real controls and custom components
- Records, row actions, and change evidence
- Function-level tools
- Regions, visibility, and overlays
- Long lists, scrolling, and offscreen actions
- State exposure
- Page identity and routing
- Assistant surfaces, layout, and task entry points
- Page feedback, target highlighting, and human guidance
- Confirmation and human handoff
- Flows, async work, and recovery
- Runtime limits, observability, and error codes
- Sensitive data
- Model gateway and authentication
- Testing, coverage, and evaluation
- Production release
- Migrating an existing Vue app
- Exposing selected capabilities to external agents
- Nuxt and SSR
React
- React learning path
- Install, provider, and mount
- Quick start: add Pling to a React app
- Inspect one agent run
- Actions with input and verified results
- Real controls and custom components
- Records, row actions, and change evidence
- Function-level tools
- Regions, visibility, and overlays
- Long lists, scrolling, and offscreen actions
- State exposure
- Page identity and routing
- Assistant surfaces, layout, and task entry points
- Page feedback, target highlighting, and guidance
- Confirmation and human handoff
- Flows, async work, and recovery
- Runtime limits, observability, and error codes
- Sensitive data
- Model gateway and authentication
- Testing, coverage, and evaluation
- Production release
- Migrating an existing React app
- Exposing selected capabilities to external agents
- Next.js and SSR
Vanilla / jQuery
- Vanilla and jQuery overview
- Script setup and first mount
- Quick start: add Pling to a vanilla page
- Declarative actions with data attributes
- Imperative actions for dynamic DOM
- Records and tables
- Forms, async updates, and dialogs
- Mount the assistant UI
- Protect sensitive data and destructive actions
- Connect vanilla pages to the model gateway
- MPA and task continuity
- Test and debug vanilla capabilities
- Add Pling to an existing jQuery app
- Expose selected capabilities to external agents
Vue 2 Legacy
- Vue 2 support statement
- Install and first mount
- Quick start
- Directive-based actions
- Records and dialogs
- Mount the assistant UI
- Test and deploy a Vue 2 app
- Migrating from Vue 2 to Vue 3
Agent Surface
- What is Agent Surface
- Designing safe capabilities
- Context and sensitive data
- Identity, consent, and delegation
- Surface basics: describe and invoke
- Transports and adapters
- Build an external agent client
- Deploy a Surface gateway
- Revoke access and audit actions
- Conformance and interoperability
- Threat model and legal boundaries
- Versioning and governance
Specification
- Scope and terminology
- Capability model
- Context model
- Control model
- Messages and envelopes
- Errors and execution results
- Transport bindings
- Security and privacy
- Conformance
- Versioning and governance
Reference
- Core declarations: actions, records, regions, state
- Agent runtime, sessions, context, limits
- UI messages, theme, locale
- Surface protocol
- Delegation and trust boundaries
- Node gateway
- Vue 3 adapter
- React adapter
- Vanilla / jQuery adapter
- Vue 2 adapter
- Error codes and diagnostics
- Continuity and projection
- Surface conformance and interoperability
- Protocol schemas and registries
API reference
Recipes
- Login, session, and protected pages
- Table rows and batch actions
- Form fill, validation, and submit
- Multi-step modal and wizard
- Dangerous actions and confirmation
- File upload and asynchronous work
- Search, filters, and long lists
- Multi-page task continuity
- Expose three safe capabilities to an external agent
- Connect an external agent through MCP
- Delegated access with user consent
- Approval, audit, and revocation for agent actions
- Use your own model key
- Pass Surface conformance with another implementation