AlertForge

Read-only. What AlertForge is, its key features, supported streaming platforms, and OBS-ecosystem compatibility.

無需輸入參數。

Requires an approved AlertForge account connection. OAuth-aware clients should start AlertForge's secure authorization flow and ask the user only to sign in and approve. Setup: https://alertforge.ai/ai-agents#agent-setup. List every animated-overlay scene kind with metadata (label, whether it animates, whether it's a cam-frame, and whether it's creatable via this agent surface -- with a one-line reason when it isn't). The four sheet-pack kinds (panel-pack, label-pack, sub-badge-pack, emote-pack) also carry `tileInputs` -- their fixed slot count, whether tile labels are locked to fixed vocabulary (sub-badge-pack only), and how the sheet is billed -- pass per-tile overrides for them as `tileTexts` in plan_overlay_pack. This is the single source of truth for scene kinds; never assume or hardcode a kind name.

無需輸入參數。

Requires an approved AlertForge account connection. OAuth-aware clients should start AlertForge's secure authorization flow and ask the user only to sign in and approve. Setup: https://alertforge.ai/ai-agents#agent-setup. List the particle overlay effects that can be Color-Dodge-blended onto a scene (max 4 per scene).

無需輸入參數。

Requires an approved AlertForge account connection. OAuth-aware clients should start AlertForge's secure authorization flow and ask the user only to sign in and approve. Setup: https://alertforge.ai/ai-agents#agent-setup. Get the caller's current AlertForge credit balance.

無需輸入參數。

Requires an approved AlertForge account connection. OAuth-aware clients should start AlertForge's secure authorization flow and ask the user only to sign in and approve. Setup: https://alertforge.ai/ai-agents#agent-setup. List the caller's animated-overlay projects, most recently updated first (up to 20).

無需輸入參數。

Requires an approved AlertForge account connection. OAuth-aware clients should start AlertForge's secure authorization flow and ask the user only to sign in and approve. Setup: https://alertforge.ai/ai-agents#agent-setup. The FIRST step for any new overlay pack -- prices the pack's shared Style Sheet (design sheet) WITHOUT spending any credits or creating anything. AlertForge's own web builder always asks the streamer these SAME 3 questions, in this order, before generating anything -- ask the USER these exact questions and pass their answers; never invent a theme yourself: (1) "What is your channel name? We use it where your logo or wordmark needs text. Letters, numbers, spaces, - and _ (max 20)." -> channelName. (2) "What should represent your channel? Describe the logo, mascot, character, or symbol you want." -> logoOrCharacterBrief. (3) "What should the overall style feel like? Describe the world, mood, visual style, and any preferred colours." -> themeAndColorsBrief. Returns a planId (valid 24 hours, single-use) plus the exact credit cost -- show that to the user, then call create_design_sheet with this planId. Scenes cannot be planned until the resulting Style Sheet has rendered (get_pack_status) AND been approved (approve_design_sheet).

Requires an approved AlertForge account connection. OAuth-aware clients should start AlertForge's secure authorization flow and ask the user only to sign in and approve. Setup: https://alertforge.ai/ai-agents#agent-setup. Consumes a plan from plan_design_sheet, spending its quoted credits and creating the project. Calling this again with the same planId after it already succeeded is safe -- it returns the same project rather than creating a second one or charging twice. Returns immediately, before the Style Sheet image has rendered -- call get_pack_status to advance rendering and get designPackage.imageUrl, show it to the user, then call approve_design_sheet once they approve it. plan_overlay_pack refuses to plan any scene on this project until that approval is recorded.

Requires an approved AlertForge account connection. OAuth-aware clients should start AlertForge's secure authorization flow and ask the user only to sign in and approve. Setup: https://alertforge.ai/ai-agents#agent-setup. Records the user's approval of a rendered Style Sheet -- call this ONLY after the user has actually seen the image from get_pack_status's designPackage.imageUrl and said they like it. This is the server-side gate: plan_overlay_pack refuses to plan any scene on this project until approve_design_sheet has been called successfully. Fails if the Style Sheet hasn't finished rendering yet -- poll get_pack_status until designPackage.status is "ready" first. Safe to call again on an already-approved project (returns the same approval, does not re-approve or error).

Requires an approved AlertForge account connection. OAuth-aware clients should start AlertForge's secure authorization flow and ask the user only to sign in and approve. Setup: https://alertforge.ai/ai-agents#agent-setup. Free to call. Prices a character-region change on an existing Style Sheet WITHOUT spending credits. Use mode=edit for a small change to the same character; use mode=redesign when replacing it with a new character while preserving the rest of the Style Sheet pixel-for-pixel. Returns a single-use 24-hour plan and exact cost; show the quote and obtain confirmation before create_style_sheet_character_edit.

Requires an approved AlertForge account connection. OAuth-aware clients should start AlertForge's secure authorization flow and ask the user only to sign in and approve. Setup: https://alertforge.ai/ai-agents#agent-setup. Spends the quoted credits and queues the character-region change from plan_style_sheet_character_edit. It keeps the same project and patches only the character slot into the current Style Sheet. Safe to retry with the same planId. The previous approval is cleared; poll get_style_sheet_character_edit_status, show the revised image to the user, then approve_design_sheet only after the user explicitly approves it.

Requires an approved AlertForge account connection. OAuth-aware clients should start AlertForge's secure authorization flow and ask the user only to sign in and approve. Setup: https://alertforge.ai/ai-agents#agent-setup. Advances the queued character edit, performs the server-side region patch, and returns the revised full Style Sheet image when complete. Call repeatedly until completed or failed. Credits reserved for a failed patch are restored.

Requires an approved AlertForge account connection. OAuth-aware clients should start AlertForge's secure authorization flow and ask the user only to sign in and approve. Setup: https://alertforge.ai/ai-agents#agent-setup. Normalizes and prices scenes to add to a DESIGN-APPROVED project WITHOUT spending any credits or creating anything. Requires `projectId` from a project whose Style Sheet has been approved via approve_design_sheet -- every scene inherits that project's approved look (visual identity comes entirely from the Style Sheet; there is no theme/reference input here anymore). Calling this without a valid approved projectId returns a structured `design_sheet_required` error (with the product's 3 onboarding questions and the exact tool sequence to follow) instead of guessing a theme -- see plan_design_sheet. Returns a planId (valid 24 hours, single-use) plus the exact credit cost and a human-readable summary -- SHOW that summary and cost to the user and get their confirmation before calling create_overlay_pack with this planId. Call list_scene_kinds first to see which scene kinds are creatable -- including alert-pack, which crops the identity from this project's Style Sheet and creates the selected production overlay alerts, plus the four sheet-pack kinds (panel-pack, label-pack, sub-badge-pack, emote-pack): each sheet kind renders ONE themed sheet and crops it into individual tile PNGs (a Twitch panel set, activity-feed labels, subscriber badges, or channel emotes) -- pass per-tile overrides via `tileTexts` on that scene entry; list_scene_kinds' `tileInputs` reports each kind's exact slot count and whether labels are locked to fixed vocabulary.

Requires an approved AlertForge account connection. OAuth-aware clients should start AlertForge's secure authorization flow and ask the user only to sign in and approve. Setup: https://alertforge.ai/ai-agents#agent-setup. Consumes a plan from plan_overlay_pack, spending its quoted credits and ATTACHING those scenes to the existing design-approved project (it never creates a new project -- that happened at create_design_sheet time). Calling this again with the same planId after it already succeeded is safe -- it returns the same project rather than attaching the scenes a second time or charging twice. Returns immediately, before any scene has rendered -- call get_pack_status afterward to advance and check progress.

Requires an approved AlertForge account connection. OAuth-aware clients should start AlertForge's secure authorization flow and ask the user only to sign in and approve. Setup: https://alertforge.ai/ai-agents#agent-setup. Advances the pack by running up to about 15 seconds of rendering work, then reports current status -- including the Style Sheet's own status and image URL (`designPackage`) and whether it has been approved (`designApproved`), plus per-scene status. A sheet-pack scene (panel-pack/label-pack/sub-badge-pack/ emote-pack) passes through an extra "tiles" stage after its sheet image renders (cropping + uploading each tile) and, once done, reports a `tiles` array (index, label, enabled, a signed download `url`, and an export-ladder `sizes` array for sub-badge-pack/emote-pack). This call has side effects -- call it repeatedly (e.g. every few seconds) until `complete` is true; each call both progresses the pack and returns its latest state. Works on a design-sheet-only project too (from create_design_sheet, before any scene exists) -- poll it until designPackage.status is "ready", then call approve_design_sheet. Every image/video link this returns (designPackage.imageUrl, previewImageUrl, resultUrl, tile urls) is a direct, absolute, signed download URL that opens with no AlertForge login -- never a dashboard link. Links expire after a while, so re-poll to get fresh ones rather than caching one long-term.

Requires an approved AlertForge account connection. OAuth-aware clients should start AlertForge's secure authorization flow and ask the user only to sign in and approve. Setup: https://alertforge.ai/ai-agents#agent-setup. Bundles the pack's finished scenes into a flat ZIP (WebMs + PNGs + manifest.json) uploaded to R2, returning a time-limited signed download URL. This is the flat agent pack, not the full themed folder-tree artifact (scenes/stinger/alerts/sheet-tile ladders with composited branding) -- that comes from the 'Download pack' button in the web editor at this result's editorUrl.

Requires an approved AlertForge account connection. OAuth-aware clients should start AlertForge's secure authorization flow and ask the user only to sign in and approve. Setup: https://alertforge.ai/ai-agents#agent-setup. Free to call. Lists the 7 AI Alert types (follow, sub, donation, bits, giftsub, host, raid), the two render tiers (Standard=Veo, Pro=Kling) with their real current credit prices (silent and with audio), and the character-generation price -- all derived live from AlertForge's billing config, never hardcoded. Call this before plan_alert_pack or generate_alert_character.

無需輸入參數。

Requires an approved AlertForge account connection. OAuth-aware clients should start AlertForge's secure authorization flow and ask the user only to sign in and approve. Setup: https://alertforge.ai/ai-agents#agent-setup. Free to call -- prices a proposed AI Alert pack WITHOUT spending any credits or creating anything. Supports a single alert, a handful, or the full set of 7: pass `alerts` with only the keys you want (e.g. one entry to create just one alert), or omit `alerts` entirely for the full 7-alert pack. Requires `characterImageUrl` -- your own uploaded/generated character (see generate_alert_character). Returns a planId (valid 24 hours, single-use) plus the exact credit cost -- show that to the user and get confirmation before calling create_alert_pack with this planId.

Requires an approved AlertForge account connection. OAuth-aware clients should start AlertForge's secure authorization flow and ask the user only to sign in and approve. Setup: https://alertforge.ai/ai-agents#agent-setup. Spends credits. Consumes a plan from plan_alert_pack and creates its alert(s). Requires an active AlertForge subscription (checked at this step, not at planning) -- fails with 'subscription_required' otherwise. Calling this again with the same planId after it already succeeded is safe -- it returns the same pack rather than creating a second one or charging twice. A single failed alert does not fail the whole call -- check each entry's `error` field in the result. Returns immediately, before any alert has rendered -- call get_alert_pack_status afterward to check progress. Timing varies by model, queue, processing route, and provider demand.

Requires an approved AlertForge account connection. OAuth-aware clients should start AlertForge's secure authorization flow and ask the user only to sign in and approve. Setup: https://alertforge.ai/ai-agents#agent-setup. Free to call. Read-only -- unlike get_pack_status, this does NOT advance anything (the render worker progresses these on its own schedule, outside this call). Reports each alert's current status (queued/running/succeeded/failed), its result WebM URL once done, its OBS overlay URL, and its credit cost. Poll at a reasonable interval until every alert reaches a terminal state; provider timing varies.

Requires an approved AlertForge account connection. OAuth-aware clients should start AlertForge's secure authorization flow and ask the user only to sign in and approve. Setup: https://alertforge.ai/ai-agents#agent-setup. Spends credits (the exact price is in list_alert_types' characterGenerateCredits). Generates a brand-new standalone character portrait from a text description via AI -- this is a still image, not a video. Returns a renderId immediately; generation is asynchronous and provider timing varies. Poll get_alert_character_status with it until status is 'completed', then use the returned `path` as characterImageUrl in plan_alert_pack.

Requires an approved AlertForge account connection. OAuth-aware clients should start AlertForge's secure authorization flow and ask the user only to sign in and approve. Setup: https://alertforge.ai/ai-agents#agent-setup. Free to call. Read-only poll for a character generation started by generate_alert_character -- call it every few seconds until status is 'completed' (with a usable `path`/`url`) or 'failed' (reserved credits are returned to the wallet automatically on failure).

Requires an approved AlertForge account connection. OAuth-aware clients should start AlertForge's secure authorization flow and ask the user only to sign in and approve. Setup: https://alertforge.ai/ai-agents#agent-setup. Free to call -- prices a single transparent WebM video (a plain animated clip, NOT an AI Alert -- no character chroma-plate, no OBS alert wiring) WITHOUT spending credits or creating anything. Returns a planId (valid 24 hours, single-use) plus the exact credit cost for the chosen model tier -- show that to the user and get confirmation before calling create_transparent_video with this planId.

Requires an approved AlertForge account connection. OAuth-aware clients should start AlertForge's secure authorization flow and ask the user only to sign in and approve. Setup: https://alertforge.ai/ai-agents#agent-setup. Spends credits. Consumes a plan from plan_transparent_video and starts the render. No subscription is required to CREATE it (only credits) -- but downloading/exporting the finished file later depends on the account's existing entitlement; plan_transparent_video's `downloadWarning` field tells you up front if the account can't download yet. Calling this again with the same planId after it already succeeded is safe -- it returns the same render rather than creating a second one. Returns immediately -- call get_render_status to check progress. Timing varies by model, duration, queue, processing route, and provider demand.

Requires an approved AlertForge account connection. OAuth-aware clients should start AlertForge's secure authorization flow and ask the user only to sign in and approve. Setup: https://alertforge.ai/ai-agents#agent-setup. Free to call. Read-only poll for any single render you own -- a transparent video created via create_transparent_video, or any other render id. Reports status and the result video URL(s) once done.