List active Effects

GET

https://api.beatapi.io/v1/effects

GET

/v1/effects

$ curl https://api.beatapi.io/v1/effects

1 {
2   "data": {
3     "object": "list",
4     "data": [
5       {
6         "id": "video-muscle-max",
7         "object": "effect",
8         "name": "Muscle Transformation",
9         "description": "string",
10         "output_type": "image",
11         "category": "transformation",
12         "tags": [
13           "string"
14         ],
15         "input": {
16           "images_min": 1,
17           "images_max": 1,
18           "accepted_types": [
19             "image/jpeg"
20           ],
21           "max_size_mb": 1,
22           "max_dimension_px": 1,
23           "subject_requirements": [
24             "string"
25           ]
26         },
27         "options": {
28           "aspect_ratios": [
29             "string"
30           ],
31           "resolutions": [
32             "string"
33           ],
34           "duration_seconds": [
35             1
36           ],
37           "bgm": true,
38           "seed": true
39         },
40         "preview": {
41           "cover_url": "string",
42           "media_url": "string"
43         },
44         "version": 1,
45         "status": "testing"
46       }
47     ]
48   }
49 }

Returns only versioned Effects that have passed BeatAPI publication gates. Internal integration names, template ids, costs, and execution context are never exposed.

Query parameters

output_typeenumOptional

Allowed values:

categorystringOptional

Response

Active Effect catalog

dataobject

Errors

400

Bad Request Error

429

Too Many Requests Error