fal.ai Integration — ModuleX AI

Field	Description	Required	Format
fal.ai API Key	Your fal.ai API key from https://fal.ai/dashboard/keys	Yes	`xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`

add_request_to_queue — Adds a request to the queue for asynchronous processing, including specifying a webhook URL for receiving updates

Parameters

string

required

The unique identifier for the fal.ai app/model (e.g. ‘lora’, ‘fast-sdxl’)

object

required

Input data for the model. Fields depend on the specific app/model being called

string

Optional URL to receive webhook updates about the request status

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "request_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Request Id"
    },
    "response_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Response Url"
    },
    "status_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status Url"
    },
    "cancel_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Cancel Url"
    }
  },
  "required": [
    "success"
  ],
  "title": "AddRequestToQueueOutput",
  "type": "object"
}

cancel_request — Cancels a request in the queue to stop a long-running task that is no longer needed

Parameters

string

required

The unique identifier for the fal.ai app/model

string

required

The unique identifier for the request to cancel

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    }
  },
  "required": [
    "success"
  ],
  "title": "CancelRequestOutput",
  "type": "object"
}

get_request_response — Gets the response of a completed request in the queue to retrieve results of an asynchronous task

Parameters

string

required

The unique identifier for the fal.ai app/model

string

required

The unique identifier for the request

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetRequestResponseOutput",
  "type": "object"
}

get_request_status — Gets the status of a request in the queue to monitor the progress of an asynchronous task

Parameters

string

required

The unique identifier for the fal.ai app/model

string

required

The unique identifier for the request

boolean

Whether to include logs in the status response

Response

{
  "$defs": {
    "LogEntry": {
      "additionalProperties": false,
      "description": "A log entry from a queued request's status.",
      "properties": {
        "message": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Message"
        },
        "level": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Level"
        },
        "timestamp": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Timestamp"
        }
      },
      "title": "LogEntry",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status"
    },
    "queue_position": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Queue Position"
    },
    "logs": {
      "items": {
        "$ref": "#/$defs/LogEntry"
      },
      "title": "Logs",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetRequestStatusOutput",
  "type": "object"
}

Using

Providers

Building

Tools

fal.ai Integration for AI Agents & Workflows

Overview

Authentication

API Key Authentication

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Limits & Quotas

Amazon Alexa

Browser Use

ElevenLabs

Links

​Overview

​Authentication

​API Key Authentication

​Required Credentials

​Available Actions

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Limits & Quotas

​Related integrations

Amazon Alexa

Browser Use

ElevenLabs

​Links

Overview

Authentication

API Key Authentication

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Limits & Quotas

Related integrations

Links