> ## 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. # Get a flow > Fetch a flow's identity and its input/output schema. Each input's `name` (its kebab-cased title) is the `node_id` you pass in a run request `inputs` entry. See [Run a flow](/api/running-apps) for the full flow. Alongside `inputs`/`outputs`, a flow may publish `params[]`, the **advanced options** its author chose to expose (a resolution, a duration, a voice, …). Each has a `name`, a `kind` (`text` | `number` | `boolean` | `enum`), a `default` (the node's value at publish time), a `group` (the node it belongs to, for grouping several under one heading), and, for `enum`/`number` kinds, `enumValues` / `min` / `max` / `step`. Unlike `inputs`, a param is never required. Omit it in the run request's `params` object and the flow uses its `default`. ## OpenAPI ````yaml api-reference/openapi.json GET /v1/apps/{appId} openapi: 3.0.3 info: title: Flowy App API version: 1.3.1 description: >- Run Flowy apps and direct generations programmatically. Authenticate with a workspace API key in the `Authorization: Bearer` header. A **secret** key (`flowy_…`) is for servers; a **publishable** key (`flowy_pk_…`) is browser-safe and only works from its allowlisted domains. Every run or generation bills the API key's own workspace credits (caller-pays), so a leaked key can never spend another workspace's balance. Keys carry **scopes**: `apps:read` (list/inspect apps), `runs:read` (poll runs), `runs:write` (start runs), `generations:read` (poll direct generations), `generations:write` (start direct generations), `assets:read` (list/read workspace assets), and `credits:read` (read the credit balance). A request that needs a scope the key doesn't hold returns `403`. A published (public) app is runnable by any key; a private app is runnable only by a key of its own workspace. servers: - url: https://apis.tryflowy.ai/genstudio-svc-v2/api description: Flowy API - url: https://fi.development.flamapis.com/genstudio-svc-v2/api description: Development - url: http://localhost:8000/genstudio-svc-v2/api description: Local security: - ApiKeyAuth: [] tags: - name: Apps description: Discover apps and inspect their input/output schema. - name: Runs description: Start runs and poll for their results. - name: Generations description: Start direct image/video generations and poll for their results. - name: Assets description: Browse the workspace's asset library (uploads + generated media). - name: Credits description: Read the workspace's credit balance. - name: Spec description: The machine-readable OpenAPI document. paths: /v1/apps/{appId}: get: tags: - Apps summary: Get an app description: >- Returns an app's identity plus its input/output schema. Use each input's `nodeId` as the key in the run request's `inputs` map. Allowed when the app is published (any key) or belongs to the key's own workspace. **Requires the `apps:read` scope.** operationId: getApp parameters: - name: appId in: path required: true schema: type: string example: 507f1f77bcf86cd799439011 responses: '200': description: App detail with input/output schema. headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/AppDetail' '401': description: Invalid or missing API key content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: >- Private app not in your workspace, or the key lacks the apps:read scope content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: App not found content: application/json: schema: $ref: '#/components/schemas/Error' components: headers: X-RateLimit-Limit: description: Maximum requests allowed in the current window (per minute). schema: type: integer example: 60 X-RateLimit-Remaining: description: Requests remaining in the current window. schema: type: integer example: 59 X-RateLimit-Reset: description: Unix epoch second at which the current window resets. schema: type: integer example: 1893456000 schemas: AppDetail: type: object properties: id: type: string example: 507f1f77bcf86cd799439011 slug: type: string example: headshot-generator title: type: string example: Headshot generator description: type: string example: Turn a selfie into a studio headshot. published: type: boolean example: true thumbnailUrl: type: string example: https://cdn.tryflowy.ai/apps/headshot.png inputs: type: array items: type: object description: >- Input field schema; each item's nodeId is the key used in the run request inputs map. outputs: type: array items: type: object Error: type: object properties: error: type: string example: this API key lacks the runs:write scope required: - error securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: flowy_* description: >- A workspace API key. Secret keys (`flowy_…`) are server-side — keep them private. Publishable keys (`flowy_pk_…`) are browser-safe but only work from their allowlisted domains. ````