Skip to main content

Quick Start

API Keys​

BotDojo supports two types of API keys:

1. Flow API Keys (Per-Flow Access)​

Flow API keys are scoped to a specific Flow and can only run that particular Flow. These are ideal when you want to grant access to a single Flow without exposing your entire project.

To create a Flow API Key:

  1. Open the Flow you want to call alt text
  2. Click Settings then API alt text
  3. Click Generate API Key and toggle the option to include API Key in curl command
  4. Paste that into a terminal and voilà

2. Project API Keys (Admin Access)​

Project API keys have admin rights to all resources in BotDojo for a particular project. These keys can call any Flow within the project and access all project resources. Use these when you need programmatic access across your entire project.

To create a Project API Key:

  1. Navigate to your Project Settings (gear icon in the top navigation)
  2. Select the API Keys tab
  3. Click Generate Project API Key
  4. Give your key a descriptive name and click Create
  5. Copy and securely store your API key (it won't be shown again)

Use Project API keys in your requests by setting the Authorization header:

Authorization: YOUR_PROJECT_API_KEY

For more details and options on calling the Flow endpoint, click the link below.

Call Flow