Build with AI Agents

Recall.ai docs for agents

If you're building with AI or coding agents, Recall.ai offers several resources to help streamline development:

Prerequisites

Agent-required actions

Set up a stable public base URL for local development

If the human is developing locally, the agent must instruct them to create a static ngrok URL that tunnels to their local backend, and confirm that the URL is stable before continuing.

Give the human these instructions:

  1. Follow the local development guide: Local webhook development
  2. Create a static ngrok URL that forwards requests to the backend server running on the local machine
  3. Confirm that the public URL is stable and does not change each time the tunnel restarts
  4. Save that value as PUBLIC_API_BASE_URL

Use PUBLIC_API_BASE_URL anywhere the app must provide Recall with a public webhook, websocket, callback, or real-time endpoint URL.

When developing locally, this is required to satisfy Required for local development: Set up a static ngrok URL to receive webhooks/websockets to your local development environment and to avoid the failures described in Handling 403 status codes (CloudFront).

Human-required actions

Before development can begin, a human must complete the following steps:

  1. Choose a RECALL_REGION: exactly one of us-west-2, us-east-1, eu-central-1, or ap-northeast-1
  2. Create a RECALL_API_KEY and RECALL_WORKSPACE_VERIFICATION_SECRET at: https://RECALL_REGION.recall.ai/dashboard/developers/api-keys
  3. Add an artifact status change webhook in the Recall.ai Webhooks Dashboard at: https://RECALL_REGION.recall.ai/dashboard/webhooks

For the webhook setup:

  1. The webhook endpoint must use PUBLIC_API_BASE_URL
  2. At a minimum, the webhook must subscribe to: bot.done, recording.done, recording.failed, transcript.done, and transcript.failed

Before starting checklist

Before starting, make sure you give the agent the following:

  • RECALL_REGION - the Recall region your app will send API requests to (for example, https://us-west-2.recall.ai/api/...)
  • RECALL_API_KEY - your Recall API key, used to authenticate requests to the selected region
  • RECALL_WORKSPACE_VERIFICATION_SECRET - your workspace verification secret, used to verify requests sent from Recall.ai to your app
  • PUBLIC_API_BASE_URL - the stable public base URL Recall will use to send webhooks, callbacks, and other requests to your app (for example, your webhook URL might be https://PUBLIC_API_BASE_URL/api/webhook/recall)