HomeQuickstart

Let’s get started with Arcade

Choose your preferred way to start building with Arcade

Python

Python

Integrate Arcade into your Python apps seamlessly

TypeScript

TypeScript

Build powerful apps with our TypeScript SDK

OpenAI

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 pre-requisites 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 SDK installation 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 API key:

from arcadepy import Arcade
 
client = Arcade(
    api_key=<ARCADE_API_KEY>
)
Keep your API key secure with environment variables

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

  1. Install python-dotenv:
pip install python-dotenv
  1. Create a .env file:
ARCADE_API_KEY=your_api_key_here
  1. Load the API key in your code:
from dotenv import load_dotenv
import os
 
load_dotenv()
api_key = os.getenv("ARCADE_API_KEY")

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

HomeIntroduction