The PolyAPI Documentation

PolyAPI is an Integration Platform as a Service (IPaaS) that simplifies building integrations via:

• AI deciphering vendor APIs

• AI building a your-language-here SDK around those APIs

• AI Assistant explaining what APIs are available and how to use them

• A serverless platform for scheduling and executing tasks using those APIs

• And much more!

Check out our main website for case studies and more information about why you should use Poly!

Note

Currently released languages are Python, JavaScript, Java, and .NET.

We have plans to add many more! Please reach out if you need support for other languages.

Contents

• Quickstart
  • Get Your API Key
  • Install the VSCode Extension
  • Asking Questions
  • Onward
• API Function Training
  • Using Postman
    • Download Postman
    • Create a New HTTP Request
    • Download the Required Scripts
    • Copy Scripts into Postman
    • Set Your API Key
    • Training Your First Function
    • Looking at Your API Function
    • Control Training with Pre-Request Options
    • Variables in Request Body
    • Editing Your Function
    • Onward
  • Using OpenAPI Specs
    • Create a Specification Input File
    • Train API Functions
    • Use Your New API Functions
    • Train Webhook Handlers
      • Define the Webhook Name and Subpath
    • Modify a Specification Input
    • Onward
• Generated SDKs
  • Python
    • Install
    • Setup and Generate
    • Develop First Function
    • Run First Function
    • Onward
  • TypeScript (Node)
    • Install
    • Setup and Generate
    • Develop First Function
    • Run First Function
    • Glide Farther
    • Onward
  • Java
    • Install
    • Develop First Function
    • Run First Function
    • Onward
  • .NET (Beta)
    • Install
    • Setup and Generate
    • Run First Function
    • Onward
• Authentication
  • Managing Users and API Keys
    • Create a User
    • Create a New API Key
    • Update / Delete an API Key
    • Update / Delete a User
  • Setting up Multi-Factor Auth (MFA)
    • Enable MFA for your Instance
    • Setup MFA for your Account
    • Verify MFA for your Account
    • Use MFA for your Account
    • Victory
    • Reset MFA
• Vari Variables
  • Vari Management UI
    • Create a Variable
    • Update/Delete a Variable
    • Conclusion
  • Vari in Your Code
    • Vari Get
    • Vari Other Methods
    • Secret vs Non-Secret Variables
    • Conclusion
• Jobs
  • Managing Jobs
    • Create a Job - Name and Schedule
    • Create a Job - Functions List
    • Create a Job - Execution Type / Enabled
    • Updating / Deleting a Job
    • Conclusion
  • Checking Job Executions
    • Execution List
    • Execution Detail
    • Conclusion
• Webhooks
  • Managing Webhooks
    • Create a Webhook
    • Updating / Deleting a Webhook
    • Conclusion
  • Managing Triggers
    • Getting Started
    • Create a Trigger
    • Updating / Deleting a Trigger
    • Conclusion
  • Testing Webhooks
    • Test
    • Test v2
    • Complex Use Cases
    • Conclusion
• Environments
  • Dev vs Prod
    • Managing Environments
      • Environment List
      • Update an Environment
      • Creating an Environment
      • Conclusion
    • Pushing to Another Environment
      • Copy Your Vari Variables
      • Replicate Your Api Functions
      • Redeploy Your Server/Client Functions
      • Conclusion
• GitHub Copilot Extension
  • Installing the Copilot Extension
    • Getting the Extension
    • VSCode Setup
    • Conclusion
  • Using the Copilot Extension
    • Enable PolyAPI Extension
    • Example
    • Conclusion
• Project Glide
  • How It’s Used
    • Git Integration
      • Starting from Scratch
      • Starting from Existing Project
    • Manually Preparing and Syncing
      • Poly Prepare
      • Poly Sync
    • Using Glide without AI
• Versions
  • PolyAPI Python
  • PolyAPI TypeScript
  • PolyAPI Java
  • PolyAPI .NET (Beta)
• Next Steps
  • Watch the Videos
  • Reach Out