List user workflows

GET

workflows

List user workflows

curl --request GET \
  --url https://api.fal.ai/v1/workflows \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.fal.ai/v1/workflows"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.fal.ai/v1/workflows', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "workflows": [
    {
      "name": "my-image-workflow",
      "title": "My Image Generation Workflow",
      "user_nickname": "johndoe",
      "created_at": "2025-01-15T12:00:00Z",
      "thumbnail_url": "https://fal.media/files/example.jpg",
      "description": "A workflow for generating images",
      "tags": [
        "image",
        "generation"
      ],
      "endpoint_ids": [
        "fal-ai/flux/dev"
      ]
    }
  ],
  "next_cursor": null,
  "has_more": false,
  "total": 1
}

{
  "error": {
    "type": "validation_error",
    "message": "Invalid request parameters"
  }
}

{
  "error": {
    "type": "authorization_error",
    "message": "Authentication required"
  }
}

{
  "error": {
    "type": "rate_limited",
    "message": "Rate limit exceeded"
  }
}

{
  "error": {
    "type": "server_error",
    "message": "An unexpected error occurred"
  }
}

Authorizations

Authorization

string

header

required

API key must be prefixed with "Key ", e.g. Authorization: Key YOUR_API_KEY

Query Parameters

limit

integer

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

Required range: x >= 1

Example:

50

cursor

string

Pagination cursor from previous response. Encodes the page number.

Example:

"Mg=="

string

Search by workflow name or title

Example:

"image generation"

used_endpoint_ids

Filter by model endpoint IDs used in the workflow. Can be a single value or comma-separated values.

Example:

["fal-ai/flux/dev"]

Response

Successfully retrieved workflows

Response containing workflow data with pagination support

workflows

object[]

required

Array of workflow items

Show child attributes

Example:

[
  {
    "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

string | null

required

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

Example:

"eyJvZmZzZXQiOjEwfQ=="

has_more

boolean

required

Whether more results are available

Example:

true

total

integer

Total number of workflows matching the query

Example:

42

Create Create a new workflow owned by the authenticated user. **Authentication:** Required. **Common Use Cases:** - Save a newly built workflow - Programmatically provision workflows **Note:** Workflow names must be unique within your namespace. Creating a workflow with a name you already use returns a 400 validation error.

⌘I

List user workflows

curl --request GET \
  --url https://api.fal.ai/v1/workflows \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.fal.ai/v1/workflows"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.fal.ai/v1/workflows', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "workflows": [
    {
      "name": "my-image-workflow",
      "title": "My Image Generation Workflow",
      "user_nickname": "johndoe",
      "created_at": "2025-01-15T12:00:00Z",
      "thumbnail_url": "https://fal.media/files/example.jpg",
      "description": "A workflow for generating images",
      "tags": [
        "image",
        "generation"
      ],
      "endpoint_ids": [
        "fal-ai/flux/dev"
      ]
    }
  ],
  "next_cursor": null,
  "has_more": false,
  "total": 1
}

{
  "error": {
    "type": "validation_error",
    "message": "Invalid request parameters"
  }
}

{
  "error": {
    "type": "authorization_error",
    "message": "Authentication required"
  }
}

{
  "error": {
    "type": "rate_limited",
    "message": "Rate limit exceeded"
  }
}

{
  "error": {
    "type": "server_error",
    "message": "An unexpected error occurred"
  }
}