Skip to main content

​
Available Operations

The Platform APIs provide the following endpoints for Serverless Apps:

​
Files

List Root Directory Contents

List the contents of the root directory of your Serverless storage.

List Directory Contents

List the contents of any nested directory by providing its path.

Download File

Download any file from Serverless storage.

Upload from URL

Upload a file from a URL into Serverless storage.

Upload Local File

Upload a local file into Serverless storage.

​
Requests

List Requests by Endpoint

List recent requests for your serverless endpoints with filtering, sorting, and pagination. Pass expand=billing to include billable_units per request — the per-request building block for cost reporting on your deployed apps.

​
Billing

Per-request billing data for your serverless apps is available through the expand=billing parameter on List Requests by Endpoint. Each request in the response includes a billable_units field representing the units fal billed for that invocation.
billable_units is the raw unit count for each request. To compute total cost, multiply by your effective per-unit price for the app. For account-level credit balance, see Account Billing.
Example
Sample response shape (truncated):
billable_units will be null if a billing event hasn’t been recorded yet for the request (e.g., the request just completed and the billing pipeline hasn’t caught up).

​
Usage

Usage

Time-bucketed, aggregated compute usage for the serverless apps you own — the machine-seconds your deployed apps consumed, priced with your machine rates and net of discounts. The aggregated counterpart to the per-request billable_units above.
Where List Requests by Endpoint gives you per-request billing, Usage gives you the rolled-up view: how many machine-seconds each of your apps consumed and what it cost, grouped by app, environment, and machine type. It reports your own compute spend, scoped to the apps you own.
This endpoint returns billing and usage data, so it requires a key on the BILLING, READONLY, or FULL preset. A key on the API preset receives a 403.

​
Filtering by app

The app field in the response is your deployed app’s name (e.g. my-app-prod). Two ways to narrow results:
  • app — exact match on one or more app names. Comma-separated or repeated, up to 50: app=my-app-dev,my-app-prod. Use the value exactly as it appears in the response.
  • search — case-insensitive substring match on the app name, for when you know the name but not the exact environment/version suffix: search=my-app returns every my-app* variant.
Provide both to combine them (AND). Omit both to return every app you own — useful for discovering the exact names to filter on.
Summary across all your apps (last 30 days)
One app, daily time series
All variants of an app by name
Sample response shape (expand=summary):
Each row is machine-seconds (unit is always "second"). Surge and non-surge usage of the same app and machine type are returned as separate rows (is_surge), so sum across them for a per-app total. Time-series bucket timestamps are returned in the timezone you request (ISO 8601 with offset, e.g. 2025-01-15T00:00:00-05:00), which also controls how usage is grouped. cost is already net of your discounts.

​
Logs

Logs History

Query paginated logs with powerful label filters, time ranges, and search keywords.

Logs Stream

Stream live logs that match the provided filters using Server-Sent Events.

​
Analytics

Analytics

Query time-bucketed metrics across all inbound traffic to your apps — request counts, error-type breakdown (startup, connection, timeout, runtime), latency percentiles (p25 through p99), cold boot metrics, and total billable duration. Ideal for exporting to your own observability tools.

​
Metrics

Queue Size

Read the current queue backlog for your serverless applications.

Metrics

Export app metrics (runners, queue size, concurrent requests, throughput, and latency) in Prometheus format for custom dashboards and monitoring.