PPTB Skills

Appearance

API Reference ​

This page indexes the complete set of APIs available to a tool running inside Power Platform ToolBox. Use it as a map: each API below covers a distinct capability, and the detailed reference for each lives on its own page.

Everything a tool can do — talk to the host shell, read/write Dataverse, call Power Platform service endpoints, persist settings, touch the file system, or react to platform events — goes through one of these documented APIs; there is no undocumented back channel into the host.

API categories ​

  • ToolBox API — platform features including connections, utilities, and terminal management.
  • Dataverse API — complete HTTP client for interacting with Microsoft Dataverse.
  • PowerPlatform API — direct access to Power Platform service endpoints and management operations.
  • Events API — subscribe to platform events like connection changes and settings updates.
  • Settings API — persistent storage for tool-specific preferences and configuration.
  • File System API — secure file operations for reading, writing, and managing files.
  • Error Handling — best practices for handling errors gracefully.

For complete TypeScript definitions covering all of the above, install the @pptb/types package:

bash
npm install --save-dev @pptb/types

Getting started path ​

For developers new to PPTB, the documentation recommends this sequence:

  1. Quickstart Guide — get up and running quickly.
  2. ToolBox API — learn about platform features.
  3. PowerPlatform API — call Power Platform service endpoints.
  4. Dataverse API — start interacting with Dataverse.
  5. Error Handling — implement robust error handling.