14 KiB
Docs • Integrations • Cookbook • Python Client • JavaScript Client
What is Arcade AI?
Arcade AI offers developer-focused tooling and APIs designed to improve the capabilities of LLM applications and agents.
By providing an authentication and authorization layer for agents and the tools agents use, Arcade AI connects agentic applications with your users' data and services - like accessing their Gmail, GitHub, Zoom, Spotify, LinkedIn, and more.
To learn more, check out our documentation.
Pst. hey, you, join our stargazers! It's free!
Quickstart
Requirements
- An Arcade AI account (current a waitlist)
- Python 3.10+. Verify your Python version by running
python --versionorpython3 --versionin your terminal - pip, the Python package installer that is typically included with Python
Installation
pip install 'arcade-ai[fastapi]'
Then login to your account (we're working through the waitlist as fast as we can!)
arcade login
This will open a browser window to login.
Verify Installation using arcade chat
The arcade-ai package comes with a CLI app called arcade chat that is used to test tools as you develop them.
By default, arcade chat will connect to the hosted version of Arcade AI with built-in tools (found in toolkits).
arcade chat
This launches a chat with the Arcade Cloud Engine (hosted at api.arcade-ai.com). All pre-built Arcade tools are available to use.
For example, try asking:
star the ArcadeAI/arcade-ai repo on Github
Arcade AI will ask you to authorize with GitHub, and then the AI assistant will star the ArcadeAI/arcade-ai repo on your behalf.
You'll see output similar to this:
Assistant (gpt-4o):
I starred the ArcadeAI/arcade-ai repo on Github for you!
You can use Ctrl-C to exit the chat at any time.
Arcade Cloud
Arcade Cloud is a hosted version of the Arcade AI engine that hosts a number of prebuilt toolkits for interacting with a variety of services.
Prebuilt Toolkits
Arcade AI offers a number of prebuilt toolkits that can be used by agents to interact with a variety of services.
| Service | Auth Type | Toolkit | Documentation |
|---|---|---|---|
 |
OAuth | Github | GitHub Toolkit Docs |
 |
OAuth | Gmail Toolkit Docs | |
 |
OAuth | Google Calendar Toolkit Docs | |
 |
OAuth | Google Docs Toolkit Docs | |
 |
OAuth | Google Drive Toolkit Docs | |
 |
API Key | Search | Search Toolkit Docs |
 |
OAuth | Slack | Slack Toolkit Docs |
 |
API Key | Web | Web Toolkit Docs |
 |
OAuth | X | X Toolkit Docs |
Supported Auth Providers
| Provider | Name | Documentation |
|---|---|---|
|
github | GitHub Auth Docs |
 |
Google Auth Docs | |
 |
LinkedIn Auth Docs | |
 |
microsoft | Microsoft Auth Docs |
|
slack | Slack Auth Docs |
 |
spotify | Spotify Auth Docs |
|
x | X Auth Docs |
 |
zoom | Zoom Auth Docs |
 |
oauth2 | Generic OAuth2 Auth Docs |
Building Your Own Tools
Learn how to build your own tools by following our creating a custom toolkit guide.
Evaluating Tools
Arcade AI enables you to evaluate your custom tools to ensure they function correctly with the AI assistant, including defining evaluation cases and using different critics.
Learn how to evaluate your tools by following our evaluating tools guide.
Models
Arcade AI supports a variety of model providers when using the Arcade AI LLM API.
To see all available models, refer to the models documentation.
Contributing
We love contributions! Please read our contributing guide before submitting a pull request. If you'd like to self-host, refer to the self-hosting documentation.