Let’s get started with Arcade

Choose your preferred way to start building with Arcade

Python

Integrate Arcade into your Python apps seamlessly

TypeScript

Build powerful apps with our TypeScript SDK

OpenAI

Works with any OpenAI library out of the box

REST API

Use Arcade's REST API with any language

Prerequisites

First, make sure you have these prerequisites installed on your system:

Arcade Account: Sign up for an Arcade account if you haven’t already.

Python 3.10+ & pip
Arcade API key

To obtain an API key, please refer to the Get an API key page.

Install and use Arcade

Install Arcade Python Client

Fire up your terminal and run:

pip install arcadepy

Set up your Arcade client

In your Python application, import the Arcade client and initialize it with your Arcade API key:

from arcadepy import Arcade
 
client = Arcade(
    api_key="your_api_key_here"
)

Keep your API key secure with environment variables

We recommend storing your API key in a .env file using python-dotenv.

Install python-dotenv:

pip install python-dotenv

Create a .env file:

ARCADE_API_KEY=your_api_key_here

Load the .env file in your code:

from dotenv import load_dotenv
 
load_dotenv()
client = Arcade() # the env var ARCADE_API_KEY is loaded automatically

Call a tool

You can now call tools with your client. Here’s an example of calling the Math.Sqrt tool:

response = client.tools.execute(
    tool_name="Math.Sqrt",
    input={"a": 625},
    user_id="[email protected]",
)
print(response.output.value)  # 25

For a complete list of available tools, visit our Toolkits page. You can explore tools for email, calendar, GitHub, and many other services.

Next steps

Learn about tools and how they work
Learn how to call tools with models
Or, jump ahead to building your own custom tools