License Downloads GitHub Contributors Visit arcade-ai.com

Follow on X Follow on LinkedIn Join our Discord

DocsIntegrationsCookbookPython ClientJavaScript Client

## What is Arcade AI? [Arcade AI](https://arcade-ai.com?ref=github) 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](https://docs.arcade-ai.com). _Pst. hey, you, join our stargazers! It's free!_ GitHub stars ## Quickstart ### Requirements 1. An **[Arcade AI account](https://arcade-ai.typeform.com/early-access)** (current a waitlist) 2. **Python 3.10+**. Verify your Python version by running `python --version` or `python3 --version` in your terminal 3. **pip**, the Python package installer that is typically included with Python ### Installation ```bash pip install 'arcade-ai[fastapi]' ``` Then login to your account (we're working through the waitlist as fast as we can!) ```bash 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`). ```bash 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](https://github.com/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
GitHub OAuth Github GitHub Toolkit Docs
Gmail OAuth Google Gmail Toolkit Docs
Google Calendar OAuth Google Google Calendar Toolkit Docs
Google Docs OAuth Google Google Docs Toolkit Docs
Google Drive OAuth Google Google Drive Toolkit Docs
Search API Key Search Search Toolkit Docs
Slack OAuth Slack Slack Toolkit Docs
Web API Key Web Web Toolkit Docs
Twitter OAuth X X Toolkit Docs

### Supported Auth Providers
Provider Name Documentation
GitHub github GitHub Auth Docs
Google google Google Auth Docs
LinkedIn linkedin LinkedIn Auth Docs
Microsoft microsoft Microsoft Auth Docs
Slack slack Slack Auth Docs
Spotify spotify Spotify Auth Docs
X x X Auth Docs
Zoom zoom Zoom Auth Docs
OAuth 2.0 oauth2 Generic OAuth2 Auth Docs
### Building Your Own Tools Learn how to build your own tools by following our [creating a custom toolkit guide](https://docs.arcade-ai.com/tools/overview). ### 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](https://docs.arcade-ai.com/home/evaluate-tools/create-an-evaluation-suite). ### 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](https://docs.arcade-ai.com/integrations/models/openai). ## Contributing We love contributions! Please read our [contributing guide](CONTRIBUTING.md) before submitting a pull request. If you'd like to self-host, refer to the [self-hosting documentation](https://docs.arcade-ai.com/home/install/overview). ## Contributors contributors

↑ Back to Top ↑