Favorite asset

Favorite an asset. Provide a request ID or vector ID; unresolved references are materialized before favorite state is added.

POST /assets/favorite

Favorite asset

cURL

curl --request POST \
  --url https://api.fal.ai/v1/assets/favorite \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "request_id": "019e6d0a-e5be-7b82-b329-35ae64296902"
}
'

import requests

url = "https://api.fal.ai/v1/assets/favorite"

payload = { "request_id": "019e6d0a-e5be-7b82-b329-35ae64296902" }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({request_id: '019e6d0a-e5be-7b82-b329-35ae64296902'})
};

fetch('https://api.fal.ai/v1/assets/favorite', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "is_favorited": true
}

{
  "error": {
    "type": "validation_error",
    "message": "Invalid request parameters"
  }
}

{
  "error": {
    "type": "authorization_error",
    "message": "Authentication required"
  }
}

{
  "error": {
    "type": "authorization_error",
    "message": "Access denied"
  }
}

{
  "error": {
    "type": "not_found",
    "message": "Resource not found"
  }
}

{
  "error": {
    "type": "validation_error",
    "message": "Invalid request parameters"
  }
}

{
  "error": {
    "type": "validation_error",
    "message": "Invalid request parameters"
  }
}

{
  "error": {
    "type": "rate_limited",
    "message": "Rate limit exceeded"
  }
}

{
  "error": {
    "type": "server_error",
    "message": "An unexpected error occurred"
  }
}

{
  "error": {
    "type": "server_error",
    "message": "Upstream asset service failed"
  }
}

Authorizations

Authorization · string · header · required

API key must be prefixed with "Key ", e.g. Authorization: Key YOUR_API_KEY

Headers

Idempotency-Key · string

Optional idempotency key for safe request retries

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json

request_id · string

Request ID to save as an asset before mutating

Minimum string length: 1

vector_id · string

Vector ID to save as an asset before mutating

Minimum string length: 1

Response

200

application/json

Asset favorited

is_favorited · boolean · required

Whether the asset is now favorited