View as Markdown
fal.ai icon

fal.ai ACTION

Cancel Request

Cancels a request in the queue. This allows you to stop a long-running task if it's no longer needed. See the documentation.
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's fal.ai account once, then configure and run Cancel Request from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "fal_ai-cancel-request",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    fal_ai: { authProvisionId: "apn_xxxxxxx" },
    appId: "App ID",
    requestId: "Request ID",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Cancel Request inputs
Property Type Description
appId App ID string
The full canonical ID of the model to call, including the owner namespace. E.g. fal-ai/flux/schnell, rundiffusion-fal/juggernaut-flux/base, or your-username/your-app. As a shorthand, a bare single-word name (e.g. lora) is accepted and assumed to be in the fal-ai namespace.
Required
requestId Request ID string
The unique identifier for the request.
Required

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
fal_ai-cancel-request
Version
1.0.1
App
fal.ai
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes