> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flowra.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Get your API key and make your first Flowra API request

Use the Flowra API with an API key. Create and manage keys in the dashboard.

## Get started in three steps

### Step 1: Get an API key

<Steps>
  <Step title="Open the dashboard">
    Go to [Flowra Dashboard](https://flowra.dev) and sign in.
  </Step>

  <Step title="Create or select a project">
    Use an existing project or create one. API keys are scoped to a project. See [Projects and API keys](/product/projects-and-keys).
  </Step>

  <Step title="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.
  </Step>
</Steps>

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

### Step 2: Call the API

Authenticate with the **x-api-key** header (or **Authorization: Bearer**). Details: [Authentication](/authentication). Prefer an [SDK](/guides/sdk) for app backends.

**Example: get your profile**

<CodeGroup>
  ```bash theme={null}
  curl -X GET "https://flowra.dev/api/v1/users/profile" \
    -H "x-api-key: YOUR_API_KEY"
  ```

  ```ts theme={null}
  import { Flowra } from '@flowra/sdk';

  const flowra = new Flowra({ apiKey: process.env.FLOWRA_API_KEY! });
  const profile = await flowra.getProfile();
  ```

  ```python theme={null}
  from flowra import Flowra

  flowra = Flowra(api_key="YOUR_API_KEY")
  profile = flowra.get_profile()
  ```
</CodeGroup>

**Example: list tools**

<CodeGroup>
  ```bash theme={null}
  curl -X GET "https://flowra.dev/api/v1/tools?limit=10" \
    -H "x-api-key: YOUR_API_KEY"
  ```

  ```ts theme={null}
  const tools = await flowra.tools.list({ limit: 10 });
  ```

  ```python theme={null}
  tools = flowra.tools.list(limit=10)
  ```
</CodeGroup>

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

```bash theme={null}
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": {} }'
```

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

### Step 3: Explore

Prefer the **SDK** for app backends:

* [SDKs](/guides/sdk) — Overview
* [TypeScript SDK](/guides/sdk-typescript) — [`@flowra/sdk`](https://www.npmjs.com/package/@flowra/sdk)
* [Python SDK](/guides/sdk-python) — [`flowra-sdk`](https://pypi.org/project/flowra-sdk/) (import `flowra`)

Also:

* [Run a workflow](/recipes/run-a-workflow) — Execute and inspect a run
* [Connect an account](/recipes/connect-an-account) — OAuth link flow
* [Tools](/guides/tools) — Search and execute tools
* [API reference](/api-reference) — Full schemas

Prefer the product first? Start with [How Flowra works](/product/how-flowra-works).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.