Reddit auth provider

The Reddit auth provider enables tools and agents to call the Reddit API on behalf of a user. Behind the scenes, the Arcade Engine and the Reddit auth provider seamlessly manage Reddit OAuth 2.0 authorization for your users.

What’s documented here

This page describes how to use and configure Reddit auth with Arcade.

This auth provider is used by:

• Your app code that needs to call Reddit APIs
• Or, your custom tools that need to call Reddit APIs

Configuring Reddit auth

In a production environment, you will most likely want to use your own Reddit app credentials. This way, your users will see your application’s name requesting permission.

You can use your own Reddit credentials in both the Arcade Cloud and in a self-hosted Arcade Engine instance.

Before showing how to configure your Reddit app credentials, let’s go through the steps to create a Reddit app.

Create a Reddit app

• Create a Reddit Application in the Reddit App Console
• Set the OAuth Redirect URL to: https://cloud.arcade.dev/api/v1/oauth/callback
• Copy the App key (Client ID) and App secret (Client Secret), which you’ll need below

Next, add the Reddit app to your Arcade Engine configuration. You can do this in the Arcade Dashboard, or by editing the engine.yaml file directly (for a self-hosted instance).

Configuring your own Reddit Auth Provider in Arcade

There are two ways to configure your Reddit app credentials in Arcade:

1. From the Arcade Dashboard GUI
2. By editing the engine.yaml file directly (for a self-hosted Arcade Engine)

We show both options step-by-step below.

export REDDIT_CLIENT_ID="<your client ID>"
export REDDIT_CLIENT_SECRET="<your client secret>"

REDDIT_CLIENT_SECRET="<your client secret>"
REDDIT_CLIENT_ID="<your client ID>"

auth:
  providers:
    - id: default-reddit
      description: "The default Reddit provider"
      enabled: true
      type: oauth2
      provider_id: reddit
      client_id: ${env:REDDIT_CLIENT_ID}
      client_secret: ${env:REDDIT_CLIENT_SECRET}

Using Reddit auth in app code

Use the Reddit auth provider in your own agents and AI apps to get a user-scoped token for the Reddit API. See authorizing agents with Arcade to understand how this works.

Use client.auth.start() to get a user token for the Reddit API:

from arcadepy import Arcade
 
client = Arcade()  # Automatically finds the `ARCADE_API_KEY` env variable
 
user_id = "user@example.com"
 
# Start the authorization process
auth_response = client.auth.start(
    user_id=user_id,
    provider="reddit",
    scopes=["identity"],
)
 
if auth_response.status != "completed":
    print("Please complete the authorization challenge in your browser:")
    print(auth_response.url)
 
# Wait for the authorization to complete
auth_response = client.auth.wait_for_completion(auth_response)
 
token = auth_response.context.token
# TODO: Do something interesting with the token...

import { Arcade } from "@arcadeai/arcadejs";
 
const client = new Arcade();
 
const userId = "user@example.com";
 
// Start the authorization process
const authResponse = await client.auth.start(userId, "reddit", {
  scopes: ["identity"],
});
 
if (authResponse.status !== "completed") {
  console.log("Please complete the authorization challenge in your browser:");
  console.log(authResponse.url);
}
 
// Wait for the authorization to complete
authResponse = await client.auth.waitForCompletion(authResponse);
 
const token = authResponse.context.token;
// Do something interesting with the token...

Using Reddit auth in custom tools

You can author your own custom tools that interact with the Reddit API.

Use the Reddit() auth class to specify that a tool requires authorization with Reddit. The context.authorization.token field will be automatically populated with the user’s Reddit token:

from typing import Annotated
 
import httpx
 
from arcade_tdk import ToolContext, tool
from arcade_tdk.auth import Reddit
 
 
@tool(
    requires_auth=Reddit(
        scopes=["identity"],
    )
)
async def get_user_info(
    context: ToolContext,
) -> Annotated[dict, "The user info"]:
    """Get the user info for the current user."""
    url = "https://oauth.reddit.com/api/v1/me"
    headers = {
        "Authorization": f"Bearer {context.authorization.token}",
        "User-Agent": "YourAppName v1.0 by u/YourRedditUsername",
    }
 
    async with httpx.AsyncClient() as client:
        response = await client.get(url, headers=headers)
        response.raise_for_status()
        return response.json()