Agent Setup Links

Setup Links are time-limited URLs that serve agent configuration instructions in a secure, self-destructing format. They provide a safer alternative to directly sharing API tokens.

How It Works

1. Go to Agents in your Broadcast sidebar
2. Click Generate Setup Link
3. A unique URL is created (e.g., https://your-instance.com/agents/setup/abc123...)
4. Share the URL with your AI agent (paste it into the chat)
5. The agent fetches the URL and self-configures with the correct credentials

What the Agent Receives

When an agent accesses the setup link, it receives a Markdown document containing:

• Your Broadcast instance URL
• The associated API token
• Token permissions
• Channel name and configuration
• CLI installation instructions
• Quick-start commands

Security

Setup Links are designed to be safe to share in chat conversations:

Once a setup link expires or reaches its access limit, it returns a 404 response. Expired links are automatically cleaned up.

Managing Setup Links

Generating a Link

From the Agents dashboard, click Generate Setup Link. The link is displayed with a copy button for easy sharing.

Revoking a Link

To immediately invalidate a setup link before it expires, click the Delete button next to it on the Agents dashboard.

Example: Onboarding Claude Code

1. Generate a setup link from the Agents dashboard
2. In Claude Code, paste: Please configure yourself to manage my Broadcast email marketing. Here's the setup link: https://your-instance.com/agents/setup/abc123...
3. Claude Code fetches the link, reads the configuration, and is ready to manage your email marketing

Example: Introduction Message

After generating a setup link, you’ll see a clipboard-ready introduction message:

I use Broadcast for email marketing. Here's how to connect:

Setup: https://your-instance.com/agents/setup/abc123...

This link expires in 1 hour. Fetch it to get your API credentials
and available commands.