Prerequisites
Before using the PolyAI ADK, you need the correct platform access and the required local tools.
Platform access¶
To use the ADK, you must have:
- access to a workspace in PolyAI Agent Studio
- a valid API key
Access and API credentials are provided by your PolyAI contact.
If you need access to the PolyAI platform, contact:
developers@poly-ai.com
Local requirements¶
Install the following tools before continuing:
| Tool | Version | Notes |
|---|---|---|
| uv | latest | Manages Python and virtual environments |
| Git | any | Required to clone the repository or contribute |
Install uv¶
uv manages Python versions for you, including the version required by the ADK. Install it with:
Alternatively, with Homebrew on macOS:
See the uv installation guide for more options.
Checklist¶
Before continuing, confirm:
- [ ] You have access to an Agent Studio workspace
- [ ] You have obtained an API key from your PolyAI contact
- [ ]
uvis installed - [ ]
gitis available locally
Next step¶
Once these requirements are in place, continue to installation.
-
Installation
Install the ADK and set up your local environment. Open installation