Skip to content

Latest commit

 

History

History
108 lines (75 loc) · 2.4 KB

page.mdx

File metadata and controls

108 lines (75 loc) · 2.4 KB
title description
Getting Your API Key
Learn how to obtain and manage your Arcade API key

import { Steps, Tabs, Callout } from "nextra/components"; import { SignupLink } from "@/app/_components/analytics";

Getting Your API Key

Before you begin, you'll need an Arcade account - if you haven't created one yet, you can sign up here. Once you have an account, you can generate API keys through either our dashboard or CLI.

<Tabs items={["Dashboard", "CLI"]}>

<Tabs.Tab>

Using the Dashboard

### Navigate to API Keys page Visit the [API Keys page](https://api.arcade.dev/dashboard/api-keys) in Arcade Dashboard.

Create a new API key

  1. Click the Create API Key button in the top right
  2. Enter a descriptive name to help identify your key
  3. Click Create API Key to generate your key

Save your API key securely

  1. Copy your API key immediately - it will only be shown once
  2. Store it securely
  3. You can always generate new keys if needed

</Tabs.Tab>

<Tabs.Tab>

Using the CLI

Install and login

  1. Install the Arcade CLI:

<Tabs items={["uv", "pip"]}> <Tabs.Tab>

uv tool install arcade-mcp
This will install the Arcade CLI as a [uv tool](https://docs.astral.sh/uv/guides/tools/#installing-tools), making it available system wide.

</Tabs.Tab> <Tabs.Tab>

pip install arcade-mcp

</Tabs.Tab>

  1. Start the login process:
arcade login

Complete setup

The CLI will automatically:

  • Print your API key to the console
  • Save your credentials to ~/.arcade/credentials.yaml

</Tabs.Tab>

API keys are administrator credentials. Anyone who has your API key can make requests to Arcade as you. Always store your API keys in a safe place, such as system environment variables, and never commit them to version control, share them publicly, or use them in browser or frontend code. ## Next Steps

Once you have your API key, you can: