API reference

Poly’s control-plane REST API is documented per instance in Swagger UI. docs.polyapi.io does not host a versioned OpenAPI JSON dump.

Open Swagger

Click Authorize and paste Bearer <api-key> (same key as Canopy and poly setup).

Schemas on Swagger are the field source of truth for create/update DTOs. These docs narrate workflows and link to Swagger when a full schema is needed.

Common starting points

Search Swagger for:

  • Functions (API / server / client create, execute, replicate)

  • Webhooks (handles, triggers)

  • Tables (Tabi)

  • Variables

  • Jobs

  • Logs

Execute-with-Vari walkthrough: Using Variables with Execute Endpoints.

Auth

See Authentication model. Keys are environment-scoped. Lost plaintext cannot be recovered; mint a new key.