FAfal
Workflows

Get workflow details

Changed on

Get detailed information about a specific workflow, including its full contents/definition.

Authentication: Required.

Common Use Cases:

  • Load a workflow for editing
  • View workflow configuration
  • Export workflow definition

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

get/workflows/{username}/{workflow_name}

Request

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

Path parameters

usernamestring required

The username of the workflow owner

Example:johndoe
workflow_namestring required

The workflow name/slug

Example:my-image-workflow

Response

Successfully retrieved workflow details

Example response

{
  "workflow": {
    "name": "my-image-workflow",
    "title": "My Image Generation Workflow",
    "user_nickname": "johndoe",
    "created_at": "2024-01-15T10:30:00Z",
    "is_public": true,
    "contents": {
      "nodes": {
        "node_a1b2c3": {
          "id": "node_a1b2c3",
          "type": "model",
          "app": "fal-ai/flux/dev",
          "depends": [],
          "input": {
            "prompt": "$input.prompt"
          },
          "metadata": {
            "position": {
              "x": 300,
              "y": 100
            }
          }
        },
        "output": {
          "id": "output",
          "type": "output",
          "depends": [
            "node_a1b2c3"
          ],
          "fields": {
            "image": "$node_a1b2c3.images.0.url"
          },
          "metadata": {
            "position": {
              "x": 600,
              "y": 100
            }
          }
        }
      }
    }
  }
}

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