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

> ## Agent Instructions
> Flowy is a node-based AI creative platform: you generate images, video, audio, 3D and vector on an infinite Canvas, refine on the Studio timeline, and export or publish from the same project.
> Prefer the Flowy MCP server (https://mcp.tryflowy.ai/mcp) or the REST API at https://apis.tryflowy.ai/v1 for programmatic work. Install with `flowy mcp install` from the @flowy/cli package.
> Credits are workspace-scoped. Generations reserve credits on start and only deduct on success, so failed runs refund automatically.

# API and Automation

> The three ways to reach Flowy from outside the browser: API keys, the MCP server, and the CLI.

Everything you can do by clicking in Flowy has a programmatic route too. This page is a signpost to the three of them. Each has its own full reference for the details.

## API keys

An API key is a scoped secret for one workspace, meant for servers and scripts. Create one under **Settings → API keys**, choose **All**, **Read Only**, or a **Restricted** set of permissions, and optionally cap its daily spend and rate limit. Runs started with a key bill that workspace. See [API keys](/settings/api-keys) to create one, and [Authentication](/api/authentication) and [Permissions](/api/permissions) for sending it and what each scope unlocks.

## The MCP server

Flowy ships a hosted [MCP](https://modelcontextprotocol.io) server at `mcp.tryflowy.ai/mcp` that connects any MCP-capable agent (Claude, Claude Code, Cursor, ChatGPT, and others) straight to your account. There's no key to copy: you sign in and consent once in the browser, and the connection is bound to your account, billing your personal wallet by default or a workspace you choose. See [MCP server](/api/mcp) for the full tool list and how to connect your agent.

## The CLI

`@tryflowy/cli` (the `flowy` command) signs you in from the terminal and can wire the hosted MCP into your agent for you. No manual config editing. It also generates media, checks your balance, and manages brand kits directly from the command line. See [CLI](/api/cli) to install it.

## Building your own integration

If you're building a product that connects to *other people's* Flowy accounts rather than only your own, register an **OAuth app** instead of using a personal API key. It requests only the scopes it needs and users can revoke it anytime. See [OAuth apps](/api/oauth) to register one, and [Connected apps](/settings/connected-apps) for how a user manages and revokes access to apps they've authorized.

<Tip>
  Not sure which one fits? A key is for your own scripts against your own workspace; the CLI is the fastest way to try Flowy from your terminal or wire up an AI agent; an OAuth app is for a product other people will connect their own Flowy account to.
</Tip>