Skip to main content

Falai/serverless

@webframp/falai/serverlessv2026.09.10.4· 1d agoMODELS
01README

fal.ai Serverless — app deployments, queue, revisions, files, logs, metrics, requests, usage

02Release Notes

2026.09.10.4

Fixed:

  • Resource instance names for get/update methods with two or more path parameters (e.g. get_app_queue_info(owner, name), get_workflow(username, workflow_name)) were built by joining raw values with "_". Two distinct owner/name pairs that split differently around an underscore (e.g. "john"/"doe_app" and "john_doe"/"app") produced the identical instance name and collided. Multi-param instance names are now derived from a hash of the JSON-encoded parameter tuple, which delimits each part unambiguously.

Upgrade note: No schema changes. All fixes are internal to method execution; existing stored resources are unaffected.

03Models1
@webframp/falai/serverlessv2026.09.10.4falai/serverless.ts

Global Arguments

ArgumentTypeDescription
apiToken?stringfal.ai API key; overrides the FAL_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
fn get_analytics(limit?: number, cursor?: string, start?: union, end?: union, timezone?: string, timeframe?: enum, bound_to_timeframe?: enum, endpoint_id?: union, expand?: union)
Analytics
ArgumentTypeDescription
limit?numberMaximum number of items to return. Actual maximum depends on query type and expansion parameters.
cursor?stringPagination cursor from previous response. Encodes the page number.
start?unionStart date in ISO8601 format (e.g., '2025-01-01T00:00:00Z' or '2025-01-01'). Defaults to 24 hours ago.
end?unionEnd date in ISO8601 format, exclusive (e.g., '2025-02-01T00:00:00Z' or '2025-02-01'). Data up to but not including this timestamp is returned. Defaults to current time.
timezone?stringTimezone for date aggregation and boundaries. All timestamps in responses are in UTC, but this controls how dates are bucketed.
timeframe?enumAggregation timeframe for timeseries data (auto-detected from date range if not specified). Auto-detection uses: minute (<2h), hour (<2d), day (<64d), week (<183d), month (>=183d).
bound_to_timeframe?enumWhether to adjust start/end dates to align with timeframe boundaries and use exclusive end. Defaults to true. When true, dates are aligned to the start of the timeframe period (e.g., start of day) and end is made exclusive (e.g., start of next day). When false, uses exact dates provided.
endpoint_id?unionFilter by specific endpoint ID(s). Accepts 1-50 endpoint IDs. Supports comma-separated values: ?endpoint_id=model1,model2 or array syntax: ?endpoint_id=model1&endpoint_id=model2
expand?unionData and metrics to include in the response. Use 'time_series' for time-bucketed data, metric names for specific metrics in time series, and 'summary' for aggregate statistics. At least one of 'time_series' or 'summary' and at least one metric are required.
fn list_apps(environment?: string, search?: string, expand?: union)
List Applications
ArgumentTypeDescription
environment?stringEnvironment to list apps from. Defaults to the main environment.
search?stringCase-insensitive substring match on the app name
expand?unionFields to expand in the response. Use endpoints to include each app's registered route-level endpoint ids.
fn get_app_queue_info(owner: string, name: string)
Queue Size
ArgumentTypeDescription
ownerstringUsername of the app owner
namestringApplication name
fn delete_serverless_flush_app_queue(owner: string, name: string)
Flush Application Queue
ArgumentTypeDescription
ownerstringUsername of the app owner
namestringApplication name
fn get_runner_history(owner: string, name: string, start?: union, end?: union, timeframe?: enum, aggregation?: enum)
Runner State History
ArgumentTypeDescription
ownerstringUsername of the app owner
namestringApplication name
start?unionStart date in ISO8601 format (e.g., '2025-01-01T00:00:00Z' or '2025-01-01'). Defaults to 24 hours ago.
end?unionEnd date in ISO8601 format, exclusive (e.g., '2025-02-01T00:00:00Z' or '2025-02-01'). Data up to but not including this timestamp is returned. Defaults to current time.
timeframe?enumBucket size for the time series (auto-detected from the date range if not specified). Auto-detection uses: minute (<2h), hour (<2d), day (<64d), week (<183d), month (>=183d).
aggregation?enumHow runner counts are aggregated within each bucket: 'max' shows peak concurrency (capacity analysis), 'avg' shows mean concurrency (utilization analysis).
fn list_app_events(owner: string, name: string, start?: union, end?: union, category?: union, limit?: number, cursor?: string)
Application Events
ArgumentTypeDescription
ownerstringUsername of the app owner
namestringApplication name
start?unionStart date in ISO8601 format (e.g., '2025-01-01T00:00:00Z' or '2025-01-01'). Defaults to 24 hours ago.
end?unionEnd date in ISO8601 format, exclusive (e.g., '2025-02-01T00:00:00Z' or '2025-02-01'). Data up to but not including this timestamp is returned. Defaults to current time.
category?unionFilter by event category. Repeat the parameter to include multiple categories: ?category=deployment_started&category=config_changed
limit?numberMaximum number of events to return per page (1-1000)
cursor?stringPagination cursor from previous response
fn list_app_revisions(owner: string, name: string, limit?: number, cursor?: string)
Application Revisions
ArgumentTypeDescription
ownerstringUsername of the app owner
namestringApplication name
limit?numberMaximum number of revisions to return per page (1-100)
cursor?stringPagination cursor from previous response
fn list_root()
List files (root)
fn list_directory(dir: string)
List files (directory)
ArgumentTypeDescription
dirstringDirectory path to list
fn upload_from_url(file: string, url: string)
Upload file from URL
ArgumentTypeDescription
filestringTarget file path (including filename)
urlstringPublicly accessible URL for the file
fn serverless_logs_history(limit?: number, cursor?: string, start?: union, end?: union, app_id?: union, revision?: string, run_source?: enum, traceback?: boolean, search?: string, level?: string, job_id?: string, request_id?: string, items: array)
Logs history (paginated)
ArgumentTypeDescription
limit?numberNumber of results per page
cursor?stringPagination cursor from previous response (timestamp-based). Use as 'until' parameter for next page.
start?unionStart date in ISO8601 format (e.g., '2025-01-01T00:00:00Z' or '2025-01-01'). Defaults to 24 hours ago.
end?unionEnd date in ISO8601 format, exclusive (e.g., '2025-02-01T00:00:00Z' or '2025-02-01'). Data up to but not including this timestamp is returned. Defaults to current time.
app_id?unionFilter by specific app ID(s) in '<owner>/<name>' format (e.g. 'fal-ai/my-app'). Accepts 1-50 app IDs. Supports comma-separated values: ?app_id=fal-ai/foo,fal-ai/bar or array syntax: ?app_id=fal-ai/foo&app_id=fal-ai/bar
revision?stringFilter by revision
run_source?enumFilter by run source
traceback?booleanInclude tracebacks
search?stringFree-text search
level?stringMinimum log level
job_id?stringFilter by job id
request_id?stringFilter by request id
itemsarray
fn list_requests_by_endpoint(limit?: number, cursor?: string, endpoint_id?: union, start?: union, end?: union, status?: enum, request_id?: string, expand?: union, sort_by?: enum)
List requests by endpoint(s)
ArgumentTypeDescription
limit?numberNumber of items to return per page (max 100)
cursor?stringPagination cursor encoding the page number
endpoint_id?unionFilter by specific endpoint ID(s). Accepts 1-50 endpoint IDs. Supports comma-separated values: ?endpoint_id=model1,model2 or array syntax: ?endpoint_id=model1&endpoint_id=model2
start?unionStart date in ISO8601 format (e.g., '2025-01-01T00:00:00Z' or '2025-01-01'). Defaults to 24 hours ago.
end?unionEnd date in ISO8601 format, exclusive (e.g., '2025-02-01T00:00:00Z' or '2025-02-01'). Data up to but not including this timestamp is returned. Defaults to current time.
status?enumFilter by request status
request_id?stringFilter by specific request ID
expand?unionFields to expand in the response. Use payloads to include input and output payloads. Use billing to include billable_units per request.
sort_by?enumSort results by end time or duration
fn get_usage(limit?: number, cursor?: string, start?: union, end?: union, timezone?: string, timeframe?: enum, bound_to_timeframe?: enum, app?: union, search?: string, expand?: union)
Usage
ArgumentTypeDescription
limit?numberMaximum number of items to return. Actual maximum depends on query type and expansion parameters.
cursor?stringPagination cursor from previous response. Encodes the page number.
start?unionStart date in ISO8601 format (e.g., '2025-01-01T00:00:00Z' or '2025-01-01'). Defaults to 24 hours ago.
end?unionEnd date in ISO8601 format, exclusive (e.g., '2025-02-01T00:00:00Z' or '2025-02-01'). Data up to but not including this timestamp is returned. Defaults to current time.
timezone?stringTimezone for date aggregation and boundaries. All timestamps in responses are in UTC, but this controls how dates are bucketed.
timeframe?enumAggregation timeframe for timeseries data (auto-detected from date range if not specified). Auto-detection uses: minute (<2h), hour (<2d), day (<64d), week (<183d), month (>=183d).
bound_to_timeframe?enumWhether to adjust start/end dates to align with timeframe boundaries and use exclusive end. Defaults to true. When true, dates are aligned to the start of the timeframe period (e.g., start of day) and end is made exclusive (e.g., start of next day). When false, uses exact dates provided.
app?unionFilter to one or more serverless apps, matched exactly against the `app` value in the response (deployed name, owner prefix stripped). Accepts a comma-separated list or repeated parameter (1-50). For partial/name-only matching use `search`.
search?stringCase-insensitive substring match on the app name — returns every app whose name contains this term (e.g. `search=autohdr` matches all `autohdr-*` apps across environments). Combined with `app` via AND when both are given.
expand?unionData to include in the response. Use 'time_series' for time-bucketed data and 'summary' for aggregate statistics across the entire window. At least one is required.

Resources

get_analytics(infinite)— Analytics
apps(infinite)— List Applications
app_queue_info(infinite)— Queue Size
get_runner_history(infinite)— Runner State History
app_events(infinite)— Application Events
app_revisions(infinite)— Application Revisions
list_root(infinite)— List files (root)
list_directory(infinite)— List files (directory)
upload_from_url(infinite)— Upload file from URL
serverless_logs_history(infinite)— Logs history (paginated)
requests_by_endpoint(infinite)— List requests by endpoint(s)
get_usage(infinite)— Usage
04Stats
A
100 / 100
Downloads
0
Archive size
27.7 KB
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License declared1/1earned
  • Verified public repository2/2earned
05Platforms
06Labels