Quickstart

Get started in three steps

Step 1: Get an API key

Open the dashboard

Create or select a project

Use an existing project or create one. API keys are scoped to a project. See Projects and API keys.

Create an API key

In your project, open Project → API Keys. Create a new key and copy it. Store it securely; you will not see the full key again.

Keep your API key secret. Do not commit it to version control or expose it in client-side code.

Step 2: Call the API

Authenticate with the x-api-key header (or Authorization: Bearer). Details: Authentication.

Example: get your profile

curl -X GET "https://flowra.dev/api/v1/users/profile" \
  -H "x-api-key: YOUR_API_KEY"

Example: list tools

curl -X GET "https://flowra.dev/api/v1/tools?limit=10" \
  -H "x-api-key: YOUR_API_KEY"

Example: execute a tool (replace the slug and body for a real tool from the list)

curl -X POST "https://flowra.dev/api/v1/tools/execute/TOOL_SLUG" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "arguments": {} }'

Base URL: Examples use https://flowra.dev/api/v1. If your project uses a different API base URL, use that instead.

Step 3: Explore

Prefer the SDK for app backends:

SDKs — Overview

TypeScript SDK — @flowra/sdk

Python SDK — flowra

Also:

Run a workflow — Execute and inspect a run

Connect an account — OAuth link flow

Tools — Search and execute tools

API reference — Full schemas

Prefer the product first? Start with How Flowra works.

Getting started

Core building blocks

Data and runtime

Integrate and scale

Recipes

Native tools

Contributing

Get started in three steps

Step 1: Get an API key

Step 2: Call the API

Step 3: Explore

​Get started in three steps

​Step 1: Get an API key

​Step 2: Call the API

​Step 3: Explore

Get started in three steps

Step 1: Get an API key

Step 2: Call the API

Step 3: Explore