Fal.ai integration: operations for AI agents
Fal.ai connects to Type.com as an integration. This page lists the 96 operations documented for Claude and Codex in Type.com: 52 read, 30 write, 14 destructive.
About Fal.ai
The generative media platform for developers with 600+ AI models for image, video, voice, and audio generation
Categories: Developer Tools & IT, Design & Media
How to connect Fal.ai to Type.com
- Access
- Organization connection: one shared account for the workspace.
- MCP
- This integration is not available through Type’s MCP server. It remains available in Type.
To add the connection, follow the steps in Space connections.
Documented operations
96 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
96 operations listed.
Models
- Read
Published model insights and weekly statistics (beta)
Experimental (beta): model guidance and evidence may change as we refine recommendations. Find model guidance by task or endpoint. Only current public models visible to the caller are returned.
- Read
Model search
Unified endpoint for discovering model endpoints. Supports three usage modes: 1. List Mode (no parameters): Paginated list of all available model endpoints with minimal metadata. 2. Find Mode (endpointid parameter): Retrieve specific model endpoint(s) by ID.
- Read
Pricing
Returns unit pricing for requested endpoint IDs. Most models use output-based pricing (e.g., per image/video with proportional adjustments for resolution/length). Some models use GPU-based pricing depending on architecture.
- Read
Usage
Returns paginated usage records for your workspace with filters for endpoint, user, date range, and auth method.
- Read
Analytics
Time-bucketed metrics per model endpoint, including request counts, success/error rates, and latency percentiles. prepareduration reflects queue/prepare time before execution; duration is request execution time. Use with the Queue/Webhooks flow to monitor SLAs.
- Read
Billing Events
Returns paginated individual billing event records with filters for endpoint and date range.
- Read
List requests by endpoint(s)
Lists requests for one or more endpoints (same endpointid style as usage/explore: comma-separated or repeated query params, up to 50 IDs). Authentication: Requires API key (user or enterprise). Filters: - Time range via start / end.
- Read
Search Requests
Search, filter, and browse your request history. Supports three modes: 1. Semantic Search (query, imageurl, or videourl parameter): Find visually or conceptually similar results using AI embeddings.
- Write
Estimate cost
Computes cost estimates using one of two methods: 1. Historical API Price (historicalapiprice): - Based on historical pricing per API call from past usage patterns - Takes callquantity (number of API calls) per endpoint - Useful for estimating based on actual historical usage pa…
- Destructive
Delete request payloads
Deletes the IO payloads and associated CDN output files for a specific request.
Workflows
- Read
List user workflows
List workflows for the authenticated user with optional search and filtering. Features: - Paginated results with cursor-based pagination - Search by workflow name or title - Filter by model endpoints used in the workflow Authentication: Required.
- Read
Get workflow details
Get detailed information about a specific workflow, including its full contents/definition. Authentication: Required. Common Use Cases: - Load a workflow for editing - View workflow configuration - Export workflow definition Required permissions: workflows:read.
- Write
Create a workflow
Create a new workflow owned by the authenticated user. Authentication: Required. Common Use Cases: - Save a newly built workflow - Programmatically provision workflows Note: Workflow names must be unique within your namespace.
Assets
- Read
Browse assets
Browse and semantically search fal Assets across all media, uploads, favorites, collections, tags, and character references. Required permissions: assets:read. Key presets that include them: API, SERVERLESS, READONLY, FULL. See key permissions.
- Read
List asset collections
List asset collections for the authenticated user's fal Assets library. Required permissions: assets:read. Key presets that include them: API, SERVERLESS, READONLY, FULL. See key permissions.
- Read
Get asset collection
Get asset collection for the authenticated user's fal Assets library. Required permissions: assets:read. Key presets that include them: API, SERVERLESS, READONLY, FULL. See key permissions.
- Read
Get asset collection hierarchy
Get the nested subtree rooted at an asset collection, plus its ancestor collections ordered from the top level down to its direct parent. Required permissions: assets:read. Key presets that include them: API, SERVERLESS, READONLY, FULL. See key permissions.
- Read
Browse assets in a collection
Browse assets in a collection for the authenticated user's fal Assets library. Required permissions: assets:read. Key presets that include them: API, SERVERLESS, READONLY, FULL. See key permissions.
- Read
List asset characters
List asset characters for the authenticated user's fal Assets library. Required permissions: assets:read. Key presets that include them: API, SERVERLESS, READONLY, FULL. See key permissions.
- Read
Get asset character
Get asset character for the authenticated user's fal Assets library. Required permissions: assets:read. Key presets that include them: API, SERVERLESS, READONLY, FULL. See key permissions.
- Read
List asset entities
List saved characters, props, environments, styles, and scenes in the authenticated account. Returns their @mention handles and defining reference images. Uses limit and offset pagination; omit types to include every entity type. Required permissions: assets:read.
- Read
Get asset entity
Get a saved entity's type, @mention handle, visual description, and defining reference images. Only entities belonging to the authenticated account are accessible. Required permissions: assets:read. Key presets that include them: API, SERVERLESS, READONLY, FULL.
- Read
List asset tags
List asset tags for the authenticated user's fal Assets library. Required permissions: assets:read. Key presets that include them: API, SERVERLESS, READONLY, FULL. See key permissions.
- Read
Get asset
Get an asset from the authenticated user's fal Assets library by asset ID; a vector ID is also accepted. Returns 404 when the asset has no live catalog record, including one whose deletion has not yet propagated to the search index. Required permissions: assets:read.
- Read
Get asset lineage
Get the derivation lineage of an asset by asset ID: the inputs it was generated from, the generation requests along the way, and any referenced smart entities, traversed recursively up to depth levels.
- Read
List tags for an asset
List tags for an asset by asset ID; a vector ID is also accepted. Assets without a live catalog record return an empty tag list. Required permissions: assets:read. Key presets that include them: API, SERVERLESS, READONLY, FULL. See key permissions.
- Write
Create asset collection
Create asset collection for the authenticated user's fal Assets library. Required permissions: assets:write. Key presets that include them: API, SERVERLESS, FULL. See key permissions.
- Write
Update asset collection
Update asset collection for the authenticated user's fal Assets library. Required permissions: assets:write. Key presets that include them: API, SERVERLESS, FULL. See key permissions.
- Write
Favorite asset collection
Favorite an asset collection for the authenticated user's fal Assets library. Required permissions: assets:write. Key presets that include them: API, SERVERLESS, FULL. See key permissions.
- Write
Unfavorite asset collection
Unfavorite an asset collection for the authenticated user's fal Assets library. Required permissions: assets:write. Key presets that include them: API, SERVERLESS, FULL. See key permissions.
- Write
Move asset collection
Move a manual asset collection under another collection, or to the top level. Only manual collections can be moved or act as folders; nesting is limited to 5 levels deep and cannot create a cycle. Required permissions: assets:write.
- Write
Add asset to collection
Add an asset to a manual or character collection. Provide exactly one asset ID, request ID, or vector ID. Unresolved request and vector IDs are materialized before membership is added. For character collections, this creates an explicit smart-entity link.
- Write
Create asset character
Create an asset character for the authenticated user's fal Assets library. Prefer vector IDs or request IDs in referenceimages for existing fal-generated assets; use fal-hosted image URLs only for standalone images.
- Write
Update asset character
Update an asset character for the authenticated user's fal Assets library. Prefer vector IDs or request IDs in referenceimages for existing fal-generated assets; use fal-hosted image URLs only for standalone images.
- Write
Favorite asset character
Favorite an asset character for the authenticated user's fal Assets library. Required permissions: assets:write. Key presets that include them: API, SERVERLESS, FULL. See key permissions.
- Write
Unfavorite asset character
Unfavorite an asset character for the authenticated user's fal Assets library. Required permissions: assets:write. Key presets that include them: API, SERVERLESS, FULL. See key permissions.
- Write
Create asset entity
Create a reusable character, prop, environment, style, or scene in fal Assets. The entity is available to @mention in the UI and agent. The handle defaults from the name and must be unique across all entity types in the account. Characters require a description.
- Write
Update asset entity
Update a saved entity without recreating it. Omitted fields stay unchanged; referenceimages replaces the defining reference set. Entity types cannot be changed. Character handles cannot be changed and character descriptions cannot be cleared.
- Write
Create asset tag
Create asset tag for the authenticated user's fal Assets library. Required permissions: assets:write. Key presets that include them: API, SERVERLESS, FULL. See key permissions.
- Write
Update asset tag
Update asset tag for the authenticated user's fal Assets library. Required permissions: assets:write. Key presets that include them: API, SERVERLESS, FULL. See key permissions.
- Write
Upload asset
Upload asset for the authenticated user's fal Assets library. Required permissions: assets:write. Key presets that include them: API, SERVERLESS, FULL. See key permissions.
- Write
Favorite asset
Favorite an asset. Provide a request ID or vector ID; unresolved references are materialized before favorite state is added. Required permissions: assets:write. Key presets that include them: API, SERVERLESS, FULL. See key permissions.
- Write
Unfavorite asset
Unfavorite an asset by request ID or vector ID. Required permissions: assets:write. Key presets that include them: API, SERVERLESS, FULL. See key permissions.
- Write
Assign tag to asset
Assign a tag to an asset. Provide a request ID or vector ID; unresolved references are materialized before tag state is added. Required permissions: assets:write. Key presets that include them: API, SERVERLESS, FULL. See key permissions.
- Destructive
Delete asset collection
Delete asset collection for the authenticated user's fal Assets library. Required permissions: assets:write. Key presets that include them: API, SERVERLESS, FULL. See key permissions.
- Destructive
Remove asset from collection
Remove an asset from a manual or character collection. Provide exactly one asset ID, request ID, or vector ID. For character collections, this removes the explicit smart-entity link. Required permissions: assets:write. Key presets that include them: API, SERVERLESS, FULL.
- Destructive
Delete asset character
Delete asset character for the authenticated user's fal Assets library. Required permissions: assets:write. Key presets that include them: API, SERVERLESS, FULL. See key permissions.
- Destructive
Delete asset entity
Delete a saved entity from the authenticated account. Its reference assets are not deleted. Required permissions: assets:write. Key presets that include them: API, SERVERLESS, FULL. See key permissions.
- Destructive
Set tags for an asset
Set tags for an asset. Provide a request ID or vector ID; unresolved references are materialized before tag state is added. Required permissions: assets:write. Key presets that include them: API, SERVERLESS, FULL. See key permissions.
- Destructive
Delete asset tag
Delete asset tag for the authenticated user's fal Assets library. Required permissions: assets:write. Key presets that include them: API, SERVERLESS, FULL. See key permissions.
- Destructive
Unassign tag from asset
Unassign a tag from an asset by request ID or vector ID. Required permissions: assets:write. Key presets that include them: API, SERVERLESS, FULL. See key permissions.
Storage
- Read
Get file ACL
Returns the Access Control List currently applied to a fal CDN file. The ACL consists of a default decision (allow, forbid, or hide) plus optional per-user rules that override the default. Rule users are returned as nicknames where possible. Authentication: Required.
- Read
Get storage settings
Returns the account-level storage lifecycle settings applied to newly uploaded fal CDN files: - expirationdurationseconds: how long files live before being automatically deleted (null disables auto-expiration).
- Write
Sign file URL
Creates a signed URL that grants temporary access to a fal CDN file, regardless of its ACL. Useful for sharing access-restricted files. The signature is valid for expirationseconds (up to 7 days). Authentication: Required. The API key must have the assets:read permission.
- Destructive
Set file ACL
Replaces the Access Control List of a fal CDN file. The ACL consists of a default decision (allow, forbid, or hide) plus optional per-user rules that override the default. Rule users may be specified by nickname or user ID.
- Destructive
Update storage settings
Replaces the account-level storage lifecycle settings applied to newly uploaded fal CDN files. Omitted or null fields are cleared (reset to the system default), so always send the full desired configuration. Sending an empty JSON object {} clears all settings.
Serverless
- Read
Analytics
Time-bucketed metrics for your serverless app endpoints, including request counts, success/error rates, and latency percentiles across all inbound traffic. prepareduration reflects queue/prepare time before execution; duration is request execution time.
- Read
List Applications
Lists the serverless applications owned by the authenticated account, with the configuration needed for follow-up calls.
- Read
Queue Size
Retrieves the current queue size for a specific application. Required permissions: serverless:queues:read. Key presets that include them: SERVERLESS, READONLY, FULL. See key permissions.
- Read
Runner State History
Returns historical runner counts by state (running, idle, pending, draining) for an application, bucketed over time.
- Read
Application Events
Returns the operational event history for an application: deployments, configuration changes, and runner lifecycle transitions (started, failed, draining, etc.), newest first.
- Read
Application Revisions
Returns the revision history for an application, newest first: every deployed version with its creation time, whether it is currently serving traffic, and a deployment status derived from recent deployment events.
- Read
List files (root)
Lists files and folders in the root of your project storage. Required permissions: serverless:files:read. Key presets that include them: SERVERLESS, DEPLOY, READONLY, FULL. See key permissions.
- Read
List files (directory)
Lists files and folders within the specified directory path. Required permissions: serverless:files:read. Key presets that include them: SERVERLESS, DEPLOY, READONLY, FULL. See key permissions.
- Read
Download file
Downloads a file by its path. Proxies the underlying storage response. Required permissions: serverless:files:read. Key presets that include them: SERVERLESS, DEPLOY, READONLY, FULL. See key permissions.
- Read
Metrics
Returns Prometheus-compatible metrics in text format for integration into your observability stack Authentication: Required - Uses API key authentication Format: Returns text/plain in Prometheus exposition format Common Use Cases: - Export app stats to your observability provide…
- Read
List requests by endpoint(s)
Lists requests for one or more endpoints owned by the authenticated user. Use repeated or comma-separated endpointid (same as other platform list APIs). A bare app id (' / ') automatically includes the app's registered route-level endpoints (e.g.
- Read
Usage
Time-bucketed, aggregated serverless compute usage for your own account — the machine-seconds your deployed serverless apps consumed, priced with your machine prices and net of discounts. This matches the serverless portion of the dashboard usage view.
- Write
Upload file from URL
Creates a new file at the target path by downloading it from the provided URL. Required permissions: serverless:files:write. Key presets that include them: SERVERLESS, DEPLOY, FULL. See key permissions.
- Write
Upload local file (multipart/form-data)
Uploads a local file using multipart/form-data. The file field name must be fileupload. Required permissions: serverless:files:write. Key presets that include them: SERVERLESS, DEPLOY, FULL. See key permissions.
- Write
Logs history (paginated)
Returns paginated historical logs that match the provided filters. Required permissions: serverless:logs:read. Key presets that include them: SERVERLESS, DEPLOY, READONLY, FULL. See key permissions.
- Write
Logs stream (SSE)
Streams live logs that match the provided filters using Server-Sent Events. Required permissions: serverless:logs:read. Key presets that include them: SERVERLESS, DEPLOY, READONLY, FULL. See key permissions.
- Destructive
Flush Application Queue
Flushes all pending requests from an application's queue. Authentication: Required via API key Idempotency: - Optional Idempotency-Key header prevents duplicate flushes on retries - Responses cached for 10 minutes per unique key Use Cases: - Clear stuck or outdated requests from…
Compute
- Read
Compute Metrics
Returns Prometheus-compatible metrics for an active compute cluster owned by the authenticated caller. Requires compute access and compute:instances:read permission. Use the computecluster query parameter to select the cluster by label.
- Read
List Compute Instances
Returns a list of all compute instances belonging to the authenticated user's workspace.
- Read
Get Compute Instance
Retrieves detailed information about a specific compute instance by its ID.
- Destructive
Delete Compute Instance
Deletes a specific compute instance by its ID. This action is irreversible.
Keys
- Read
List API Keys
Returns a list of all API keys belonging to the authenticated user's workspace.
- Write
Create API Key
Creates a new API key with the specified alias. Keys are created with granular permissions. Pass preset for a named preset or permissions to list them explicitly; omit both to get the API preset. Important Security Notice: The keysecret is only returned once at creation time.
- Destructive
Revoke API Key
Revokes an API key by its ID, so it can no longer be used. This action is irreversible. The key stops working immediately and drops out of GET /v1/keys, but the record is retained with when it was revoked and by whom.
Account
- Read
Account Billing
Returns billing information for the authenticated account. Use the expand parameter to include additional details.
- Read
FOCUS Report
Returns a FOCUS compliant billing report as a CSV download. Availability: This endpoint is available to enterprise customers with FOCUS reports enabled. Contact your account team or support@fal.ai to request access.
- Read
Model Access Controls Report
Returns the current model access controls for your organization as a CSV download. Availability: This endpoint is available to enterprise customers with model access controls enabled. Contact your account team or support@fal.ai to request access.
Organization
- Read
Organization Billing Events
Returns paginated individual billing event records across all teams in your organization, with each record attributed to a specific team via the username field.
- Read
Organization FOCUS Report
Returns a FOCUS compliant billing report as a CSV download, spanning every team in your organization. Each invoiced billing customer is reported as a BillingAccount.
- Read
Organization Teams
Returns the list of teams in your organization with their details. Availability: This endpoint is available to enterprise customers with organizations enabled. Contact your account team or support@fal.ai to request access.
- Read
Organization Usage
Returns paginated usage records across all teams and product lines in your organization, with each record attributed to a specific team via the username field and a product line via the product field.
Meta
- Read
Get platform metadata
Returns platform metadata including webhook IP ranges for allowlisting. If your infrastructure requires allowlisting IP addresses for incoming webhook requests, this endpoint provides the current list of IP ranges used by fal.ai webhooks in CIDR notation.
Queue
- Read
Get request status
Get the state of a queue request. Poll this operation until status is COMPLETED, then get the result. To receive updates without polling, use the status stream.
- Read
Stream request status
Receive status updates as server-sent events. Each event has a data: line with a status object. The status object has the same fields as the response of Get request status. The server closes the stream after it sends the COMPLETED event.
- Read
Get request result
Get the result of a completed request. The response has the status code, headers, and body that the model returned. If the model returned an error, this operation returns the same error. fal keeps the result for 1 hour after the request completes.
- Write
Submit a request
Add a model request to the queue. The response contains the request ID and the URLs for status, result, and cancellation. The queue keeps the request until a runner is available. The queue has no size limit unless you send falmaxqueuelength.
- Write
Submit a request to an endpoint path
Add a request for a model endpoint path to the queue. Use this operation when the model ID has more than two segments, for example blackforestlabs/flux-3-max/text-to-video. The response contains the request ID and the URLs for status, result, and cancellation.
- Destructive
Cancel a request
Cancel a queue request. If the request is in the queue, fal removes it. If the request is in progress, fal sends a cancellation signal to the runner. The model app decides how to stop the work. See Handle cancellations.
Synchronous
- Write
Run a model
Run a model and wait for the result. fal does not retry synchronous requests. If a request fails because of a temporary error, the response has X-Fal-Needs-Retry: 1. For long requests, use the Queue API.
- Write
Run an endpoint path
Run a model endpoint path and wait for the result. Use this operation when the model ID has more than two segments, for example blackforestlabs/flux-3-max/text-to-video. For models with a streaming endpoint, use the path stream to receive server-sent events.
No operations match.
See How connections work for access and permissions, or browse all integrations.