> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.beatapi.io/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.beatapi.io/_mcp/server. # List active Effects GET https://api.beatapi.io/v1/effects Returns only versioned Effects that have passed BeatAPI publication gates. Internal integration names, template ids, costs, and execution context are never exposed. Reference: https://docs.beatapi.io/api-reference/core/effects/list-effects ## Request ### Query parameters - `output_type` (enum, optional) - Allowed values: `image`, `video` - `category` (string, optional) ## Response ### 200 Active Effect catalog - `data` (EffectListResponseData, required) ## Errors ### 400 Bad Request Error Malformed JSON or a field, value or combination this endpoint does not accept (`bad_request`; the message names the field), or input refused by moderation (`content_policy_violation`). Not retryable unchanged. - `error` (ErrorError, required) — Structured BeatAPI error. Use `code` (or `retryable`) for program logic and retain `request_id` for support. ### 429 Too Many Requests Error Too many requests (`rate_limit_exceeded`, including the free-model limits) or too many tasks processing at once (`user_concurrency_exceeded`). Retryable after `Retry-After` seconds (also `error.retry_after_seconds`). - `error` (ErrorError, required) — Structured BeatAPI error. Use `code` (or `retryable`) for program logic and retain `request_id` for support. ## Types ### EffectListResponseData - `object` (enum, required) - Allowed values: `list` - `data` (list of Effect, required) ### ErrorError Structured BeatAPI error. Use `code` (or `retryable`) for program logic and retain `request_id` for support. - `code` (enum, required) — Stable machine-readable error code. `unauthorized` is the deprecated name for a 401; since 2026-09-29 a 401 is `missing_api_key` or `invalid_api_key`. Treat a legacy `unauthorized` like `invalid_api_key`. - Allowed values: `bad_request`, `missing_api_key`, `invalid_api_key`, `unauthorized`, `forbidden`, `not_found`, `insufficient_credits`, `idempotency_conflict`, `user_concurrency_exceeded`, `rate_limit_exceeded`, `content_policy_violation`, `processing_unavailable`, `processing_failed`, `processing_timeout`, `result_transfer_failed`, `invalid_signature`, `realtime_disabled`, `realtime_capacity_unavailable`, `realtime_session_expired`, `origin_not_allowed`, `invalid_client_secret`, `transport_not_allowed`, `internal_error` - `message` (string, required) — English sentence that states the cause; for `bad_request` it names the field. Written for people and logs, not for parsing. - `retryable` (boolean, required) — Whether making the same call again could succeed. Present on every error; branch on it instead of the status code. True for 429, 500 and 503 (rate_limit_exceeded, user_concurrency_exceeded, internal_error, processing_unavailable, processing_timeout, processing_failed, result_transfer_failed, realtime_capacity_unavailable). False for a request, key or balance that must change first (bad_request, content_policy_violation, missing_api_key, invalid_api_key, insufficient_credits, forbidden, not_found, idempotency_conflict, realtime_disabled and the other realtime credential codes). - `request_id` (string, required) — Correlation ID to retain for BeatAPI support. - `retry_after_seconds` (integer, optional) — Seconds to wait before retrying. Present on every 429, and on a 503 when the wait is known; the same value is sent in the `Retry-After` header. - `docs` (string, optional) — The public Skill page that says what to do about an error. Present on errors answered by the capability endpoints (`/v1/capabilities/search`, `/v1/capabilities/inspect`, `/v1/capabilities/run`); absent on every other endpoint. ### Effect - `id` (string, required) - `object` (enum, required) - Allowed values: `effect` - `name` (string, required) - `description` (string, required) - `output_type` (enum, required) - Allowed values: `image`, `video` - `category` (string, required) - `tags` (list of string, required) - `input` (EffectInput, required) - `options` (EffectOptions, required) - `preview` (EffectPreview, required) - `version` (integer, required) - `status` (enum, required) - Allowed values: `testing`, `active`, `paused` ### EffectInput - `images_min` (integer, required) - `images_max` (integer, required) - `accepted_types` (list of enum, required) - Allowed values: `image/jpeg`, `image/png`, `image/webp` - `max_size_mb` (integer, optional) — Maximum downloaded bytes per input image. When omitted, BeatAPI enforces 50 MB. - `max_dimension_px` (integer, optional) — Maximum decoded width or height. BeatAPI inspects the actual image header before charging. - `subject_requirements` (list of string, optional) ### EffectOptions - `aspect_ratios` (list of string, optional) - `resolutions` (list of string, optional) - `duration_seconds` (list of integer, optional) - `bgm` (boolean, optional) - `seed` (boolean, optional) ### EffectPreview - `cover_url` (string, required, nullable) - `media_url` (string, required, nullable) ## Examples **Response** ```json { "data": { "object": "list", "data": [ { "id": "video-muscle-max", "object": "effect", "name": "Muscle Transformation", "description": "string", "output_type": "image", "category": "transformation", "tags": [ "string" ], "input": { "images_min": 1, "images_max": 1, "accepted_types": [ "image/jpeg" ], "max_size_mb": 1, "max_dimension_px": 1, "subject_requirements": [ "string" ] }, "options": { "aspect_ratios": [ "string" ], "resolutions": [ "string" ], "duration_seconds": [ 1 ], "bgm": true, "seed": true }, "preview": { "cover_url": "string", "media_url": "string" }, "version": 1, "status": "testing" } ] } } ``` **SDK Code** ```python import requests url = "https://api.beatapi.io/v1/effects" response = requests.get(url) print(response.json()) ``` ```javascript const url = 'https://api.beatapi.io/v1/effects'; const options = {method: 'GET'}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.beatapi.io/v1/effects" req, _ := http.NewRequest("GET", url, nil) res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.beatapi.io/v1/effects") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.beatapi.io/v1/effects") .asString(); ``` ```php request('GET', 'https://api.beatapi.io/v1/effects'); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.beatapi.io/v1/effects"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let request = NSMutableURLRequest(url: NSURL(string: "https://api.beatapi.io/v1/effects")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```