Quickstart

Get Your API Key

To create a PolyAPI account, first head over to PolyAPI and click “Sign Up Now!”

Complete the form and enter your verification code.

In a minute or two, your tenant should be all setup and you should receive your trial account API key via email! You will be automatically placed in our Trial Tier

Install the VSCode Extension

Important

Alternatively for “NA1” instances, you can use the public beta of our PolyAPI GitHub Copilot Extension with GitHub Copilot.

Please refer to GitHub Copilot Extension for more information.

Helpful Resource

Setting up Poly Video

  • Open Visual Studio Code

  • Go to Extensions (Ctrl+Shift+X)

  • Search for “Poly Assistant”

  • Click on Install

The VSCode PolyAPI Extension will guide you through the process of entering your API key and selecting the language you’d like to use. Just click on the Poly view in VS Code and select “Setup Poly client”.

Asking Questions

To get started click the Parrot icon in the Primary Side Bar.

You should see a pane open with a chat interface.

Click where is says “Ask Poly about APIs and Events” to get started.

Poly knows how to interact with about a dozen APIs out-of-the-box. For example, you can ask:

  • “How do I create a new contact on Hubspot?”

  • “How do I search for a customer on Stripe?”

You can click the Palm Tree icon to see a tree of all the APIs Poly knows about.

Feel free to ask about whatever API you’re interested in!

If you run into any issues or feel that Poly is unclear, please email support@polyapi.io.

Onward

The next step on the guided tour of Poly is to train your first API Function and use it in your code!