> ## 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.

# Flow API

> This flow's own API reference, with real code ready to copy for every input it defines.

The **API** tab, at `/app/:slug/api`, is a documentation page scoped to just this one flow. The same [REST API](/api/running-apps) every flow shares, but with the placeholders filled in: your flow's real ID and its actual input names, so the code on the page runs as written instead of needing edits first.

## What's on the page

A sticky table of contents down the side and numbered sections walk through calling the flow: authenticating, starting a run with its real inputs, and reading back the result. Each code block has a language tab bar (cURL, Python, JavaScript, PHP, Go, Java, and Ruby) that switches every block on the page together, and every block is copyable.

<Note>
  If you haven't created an API key yet, the tab links straight to [creating one](/settings/api-keys).
</Note>

## Where the full reference lives

This tab is the fast path for one flow; for the complete picture of the API. Every endpoint, the [permission scopes](/api/permissions) each one needs, and the end-to-end [run-and-poll walkthrough](/api/running-apps). See the API Reference section of these docs. [Start a run](/api/start-run) documents the exact request this tab's "start a run" snippet is calling.