FAfal
Workflows

List user workflows

Changed on

List workflows for the authenticated user with optional search and filtering.

Features:

  • Paginated results with cursor-based pagination
  • Search by workflow name or title
  • Filter by model endpoints used in the workflow

Authentication: Required. Returns only workflows owned by the authenticated user.

Common Use Cases:

  • Display user's workflow library
  • Search for specific workflows
  • Find workflows using particular models

Required permissions: workflows:read. Key presets that include them: API, SERVERLESS, READONLY, FULL. See key permissions.

get/workflows

Request

  • Base URL
    https://api.fal.ai/v1
  • URL
    https://api.fal.ai/v1/workflows
  • Auth
    API key in header Authorization

Query parameters

limitinteger

Maximum number of items to return. Actual maximum depends on query type and expansion parameters.

Example:50
cursorstring

Pagination cursor from previous response. Encodes the page number.

Example:Mg==
searchstring

Search by workflow name or title

Example:image generation
string
OR
string[]

Response

Successfully retrieved workflows

next_cursorstring nullable required

Cursor for the next page of results, null if no more pages

has_moreboolean required

Whether more results are available

totalinteger

Total number of workflows matching the query

Example response

{
  "workflows": [
    {
      "name": "my-image-workflow",
      "title": "My Image Generation Workflow",
      "user_nickname": "johndoe",
      "created_at": "2024-01-15T10:30:00Z",
      "thumbnail_url": "https://fal.ai/workflows/thumb_abc123.png",
      "description": "Generate high-quality images using FLUX model",
      "tags": [
        "image-generation",
        "ai",
        "flux"
      ],
      "endpoint_ids": [
        "fal-ai/flux/dev",
        "fal-ai/face-swap"
      ]
    }
  ],
  "next_cursor": "eyJvZmZzZXQiOjEwfQ==",
  "has_more": true,
  "total": 42
}

Changes

  • 479db2f9dcd6Revision changes
    • info

      the endpoint scheme security readonlyApiKey was added to the API

    • info

      the endpoint scheme security apiKey was removed from the API