Get workflow details

GET

workflows

{username}

{workflow_name}

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

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

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

{
  "workflow": {
    "name": "my-image-workflow",
    "title": "My Image Generation Workflow",
    "user_nickname": "johndoe",
    "created_at": "2025-01-15T12:00:00Z",
    "is_public": false,
    "contents": {
      "nodes": [],
      "edges": []
    }
  }
}

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

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

{
  "error": {
    "type": "authorization_error",
    "message": "Access denied"
  }
}

{
  "error": {
    "type": "not_found",
    "message": "Resource not found"
  }
}

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

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

Authorizations

Authorization

string

header

required

Key on the READONLY preset, or any key whose permissions include the ones this API lists. Prefix it with "Key ", e.g. Authorization: Key YOUR_API_KEY

Path Parameters

username

string

required

The username of the workflow owner

Maximum string length: 128

Pattern: ^[a-zA-Z0-9_-]+$

Example:

"johndoe"

workflow_name

string

required

The workflow name/slug

Maximum string length: 128

Pattern: ^[a-zA-Z0-9_-]+$

Example:

"my-image-workflow"

Response

Successfully retrieved workflow details

Response containing a single workflow's details

workflow

object

required

The workflow details

Hide child attributes

workflow.name

string

required

Unique workflow name/slug within the user's namespace

Example:

"my-image-workflow"

workflow.title

string

required

Human-readable workflow title

Example:

"My Image Generation Workflow"

workflow.user_nickname

string

required

Display name/username of the owner

Example:

"johndoe"

workflow.created_at

string

required

ISO8601 timestamp of workflow creation

Example:

"2024-01-15T10:30:00Z"

workflow.is_public

boolean

required

Whether the workflow is publicly visible

Example:

true

workflow.contents

object

required

The workflow definition/configuration object

Hide child attributes

workflow.contents.{key}

any

Example:

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

Example:

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

⌘I

Get workflow details

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

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

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

{
  "workflow": {
    "name": "my-image-workflow",
    "title": "My Image Generation Workflow",
    "user_nickname": "johndoe",
    "created_at": "2025-01-15T12:00:00Z",
    "is_public": false,
    "contents": {
      "nodes": [],
      "edges": []
    }
  }
}

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

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

{
  "error": {
    "type": "authorization_error",
    "message": "Access denied"
  }
}

{
  "error": {
    "type": "not_found",
    "message": "Resource not found"
  }
}

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

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