Siren

Get the connected Siren workspace: plan, key scopes, auto-post setting, and daily limit. Call this first to learn what the account can do before generating. Empty asset_types / channels / connected_accounts lists mean UNRESTRICTED, not missing — never stop on them. Film renders need plan pro or above (empire/scale/pro).

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

List the workspace's generation runs (newest first): status, brief, channel, asset URLs, and caption. Page with offset to see them all.

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 10,
      "description": "How many runs to return, 1 to 50. Newest first.",
      "type": "integer"
    },
    "offset": {
      "default": 0,
      "description": "Skip this many runs, to page back through every video and image the workspace has made.",
      "type": "integer"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Get one run by id — full status, output text, asset URLs, caption, and any error. Poll this after create_campaign or render_asset until status is terminal. Wait `poll_after_seconds` between polls; `progress` and `eta_seconds` say how far along it is. A finished film carries `film_check`, advice only: when `ok` is false, show the human the video and the findings and let them decide. Re-render at most once, and only for a defect you can name in what you sent (a missing image, a wrong name). `notices` are plain-words notes on the request (e.g. it asked for a mood the brand's look does not wear): the asset is made as asked; pass the note to the human. A finished run carries `caption`: the post caption Siren wrote in the run's brand (or yours, if you passed one); show it with the asset. After post_run, `posts[]` carries each platform's status and, once it fires, the live URL and the caption that went out.

{
  "type": "object",
  "properties": {
    "run_id": {
      "description": "The run id returned by create_campaign, render_asset, or list_runs.",
      "type": "string"
    }
  },
  "required": [
    "run_id"
  ],
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Create a Siren campaign from a plain-language brief — the full pipeline: plan, on-brand copy, deterministic render, verify. Returns the run; poll get_run until it finishes. Spends credits (image 10, video 25; voice or music-only is the same 25). Pass output_type to pin a film (list_films has the catalog); omit it and Siren picks. Optional scheduled_at (ISO-8601) queues a sequential post (X → Instagram → TikTok, or platforms you pass) when the render succeeds — requires Allow posting. Fails with a 402 upgrade message if the plan or balance can't cover it. FILM KNOBS: voiceover (true narrated / false music only), direction (mood, pace, motion, music in one line), music (a bed id), media (upload_media URLs the film shows). Images ignore the film knobs: Siren writes and paints them from the brief and Brand DNA. ANY BRAND: pass `brand` to make it for a brand that is not this workspace's own, e.g. brand={"name": "Acme", "site": "acme.com", "logo_url": "https://acme.com/logo.png", "primary": "#FF4400"}. Nothing of this workspace's identity leaks in. The exact same request within 24 hours returns the run it already started, as it is now, with replayed=true and no new charge. Change the brief to make another.

{
  "type": "object",
  "properties": {
    "brief": {
      "description": "Plain-language request for the post, e.g. \"announce the new export feature, use the dashboard screenshot\".",
      "type": "string"
    },
    "channel": {
      "default": "twitter",
      "description": "Target channel for the render: twitter, instagram, linkedin, tiktok, or youtube. Sets the default aspect (X square, Instagram 4:5, TikTok 9:16) and copy length. A shape named in the brief wins: square, vertical, portrait, story, wide, landscape, 4:5, 9:16, 16:9.",
      "type": "string"
    },
    "asset_type": {
      "default": "card",
      "description": "What to make: card (still image) or video.",
      "type": "string"
    },
    "output_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional film to pin, e.g. \"story\" or \"pitch\". Call list_films to browse; describe_film for the contract. Omit and Siren picks the format from the brief."
    },
    "caption": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional caption for the post this run becomes. Your words are kept; omit and Siren writes the caption."
    },
    "scheduled_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "ISO-8601 time to post, e.g. 2026-09-12T09:00:00. Interpreted in the given timezone."
    },
    "timezone": {
      "default": "UTC",
      "description": "IANA timezone name for scheduled_at, e.g. Africa/Lagos or America/New_York.",
      "type": "string"
    },
    "platforms": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Where to post: any of x, instagram, tiktok, linkedin, youtube, or [\"everything\"] for every connected channel."
    },
    "voiceover": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Films: true = narrated in the brand voice, false = motion + music only. Omit and the brief decides; if the human never said, ask them once."
    },
    "direction": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Films: one free line on mood, pace, motion and music, e.g. \"emotional, slow, soft piano\" or \"dark, club energy, fast cuts\"."
    },
    "music": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Films: a music bed track_id. Omit and the bed follows the film and the direction."
    },
    "media": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Films: URLs from upload_media (images and videos) for the film to show. Omit and the film shows the brand's recent work. Images: not used; add pictures to Brand DNA with upload_product_screen instead."
    },
    "brand": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Make it for ANOTHER brand instead of this workspace's own (a client, a brand people recognise, a side project). Object: {name (required), site, logo_url (https PNG/SVG/JPG of the brand's MARK or app icon, e.g. Duolingo's owl, not the wordmark: the film sets the name in type), accent (hex: the brand's signature colour, the one films are painted in), primary (hex: its dark or ink colour), secondary, tagline, font (the brand's typeface name, e.g. Nunito), x_handle, sells (one line: what they make)}. Clean slate: none of this workspace's logo, colours, mascot, font, handle, screenshots or memory is used; only what you send. YOU look the brand up first: their site, their logo file (the image in their site header, or their /brand or /press page, or the app icon) and their colours as hex. A missing, dead or damaged logo is refused (brand_logo_required / brand_logo_unreachable / brand_logo_unreadable) because a film with no mark is a generic video; one colour for both primary and accent is refused too. Never invent a logo URL and never pass a screenshot of their page as the logo. Omit to use this workspace's Brand DNA."
    }
  },
  "required": [
    "brief"
  ],
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

The film library, one ranked page at a time. Films sit on job shelves; pass job and the human's goal and hire from the top of the page. Each film says what it is, when to hire it, its length and shapes, fits_this_brand (with what is missing) and made_recently (this brand already got it: prefer another film on the shelf unless the human asked for that one). Page on with next_page. Want it all at once? all=true, or fetch the catalog file (https://api.mysiren.ai/api/v1/films.md, every film by shelf, also .txt/.json) and read it in steps. search= finds films by word. Then describe_film for the body. Video renders need Pro or above. Every film here is 25 credits. Platinum films (50 credits) are not in these pages: the answer's platinum section flags them, and list_platinum_films has the shelf.

{
  "type": "object",
  "properties": {
    "job": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "The shelf: launch, feature (one feature or update), explain (what the product does), brand (story, manifesto, mood), ai (AI or agent product), proof (a number, testimonials), app (mobile app), shop (products, food, property), people (team or mascot). Omit to rank the whole library."
    },
    "goal": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "The human's own words for the outcome, e.g. \"launch video for our new AI agent\" or \"show our 10k users\". Ranks the films by fit."
    },
    "page": {
      "default": 1,
      "description": "Page number, from 1. Each page is page_size films; next_page in the answer says what to call next.",
      "type": "integer"
    },
    "page_size": {
      "default": 8,
      "description": "Films per page, 1 to 25.",
      "type": "integer"
    },
    "max_seconds": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Only films this long or shorter, e.g. 15 for a short feed post."
    },
    "narrated": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "true = only films with a voice-over part; false = only music-and-motion films."
    },
    "aspect": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Only films that render this shape: wide-desktop, square-ig, story-reel, vertical-ig-feed."
    },
    "detail": {
      "default": "short",
      "description": "\"short\" (default) or \"full\" to add the long description per film.",
      "type": "string"
    },
    "search": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Find films by word across ids, names and descriptions, e.g. \"phone\", \"chat\", \"mascot\", \"halftone\". Every word must match."
    },
    "all": {
      "default": false,
      "description": "true = every film that passes the filters on one page (about 10k tokens for the whole library). Prefer job + page, or the catalog.md file.",
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

The platinum shelf: studio-grade films that match a top motion studio's craft, told as the brand's own story. Each costs 50 credits, every time (a normal film is 25). Offer one only when the human is making a big launch they genuinely want to go far; everyday posts and normal budgets use list_films. Say the price before you render. Ids end in -plt. Platinum needs a paid plan or a credit top-up: a complimentary plan sees it but gets 402 platinum_needs_paid_plan. voice MM = motion and music only (no voice-over question, no narration); MVM = motion, voice and music. Then describe_film for the body, same as any film.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

The still style library, one ranked page at a time. Every painted still (an ad creative, poster, launch card, App Store frame, thumbnail) is one style; Siren picks one when you don't. Styles sit on section shelves; pass section and the human's goal and take one from the top. made_recently = this brand already got that look, prefer another. To paint in a style, put its id in the create_campaign brief (asset_type card). The whole library as one file: https://api.mysiren.ai/api/v1/styles.md (also .txt/.json).

{
  "type": "object",
  "properties": {
    "section": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "The shelf: social-ad (feed ads), poster, launch, brand, og (link previews), youtube (thumbnails), app-store, event, wallpaper, arts-creative. Omit to rank the whole library."
    },
    "goal": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "The human's own words for the still, e.g. \"a hot take about launches\" or \"our pricing is simple\". Ranks the styles by fit."
    },
    "page": {
      "default": 1,
      "description": "Page number, from 1. next_page in the answer says what to call next.",
      "type": "integer"
    },
    "page_size": {
      "default": 8,
      "description": "Styles per page, 1 to 25.",
      "type": "integer"
    },
    "search": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Find styles by word in their id or when-to-pick line, e.g. \"comic\", \"receipt\", \"billboard\"."
    },
    "aspect": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Only styles that paint on this shape: square-ig, vertical-ig-feed, story-reel, wide-desktop."
    },
    "all": {
      "default": false,
      "description": "true = every style that passes the filters on one page. Prefer section + page, or the styles.md file.",
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

The full contract for one film: what it is and when to hire it, its body JSON Schema, a reference body, the seed envelope, media slots (which fields take image/video URLs), the brand prefills (colours, logo, screens) and the override rules. Call it before writing a render_asset body.

{
  "type": "object",
  "properties": {
    "output_type": {
      "description": "Film id from list_films, e.g. \"story\", \"pitch\", \"gallery\".",
      "type": "string"
    }
  },
  "required": [
    "output_type"
  ],
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Ask Siren's clarifier whether a brief is specific enough to generate from. Returns ready=true/false plus follow-up questions. Use before create_campaign when the user's request is vague.

{
  "type": "object",
  "properties": {
    "brief": {
      "description": "Plain-language request for the post, e.g. \"announce the new export feature, use the dashboard screenshot\".",
      "type": "string"
    }
  },
  "required": [
    "brief"
  ],
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Render films from pre-formed SirenSeed bodies (advanced). FILMS ONLY: images are painted from a brief, so for any image, ad or creative call create_campaign with asset_type=card (a still here returns 422 stills_use_a_brief). Each item: {output_type, channel, seed_body, archetype?, family?, surface?, caption?, voice_id?, music?, direction?, brand_override?}. Prefer create_campaign unless the user has concrete seed JSON. Returns run ids, `estimated_seconds` and `poll_after_seconds`; wait that long, then get_run. THE DIRECTOR: every film body is edited against Brand DNA before it renders. It keeps the film and your brand-specific lines, rewrites empty, generic or reference-body copy, and never touches media. `director` in the response says what changed. `direction` is a free line ("dark, club energy, fast") that steers words, pace and music. A film that cannot use what you sent returns 422 film_does_not_fit with a `fix` and `films_that_fit`. ANY BRAND: put brand_override={"name": "Acme", "site": "acme.com", "logo_url": "https://acme.com/logo.png", "primary": "#FF4400", "accent": "#111111"} on an item to render it for a brand that is not this workspace's own. With a name it is a clean slate: none of this workspace's logo, mascot, font, handle, screenshots or stills are used. Media slots take only URLs you uploaded with upload_media.

{
  "type": "object",
  "properties": {
    "items": {
      "description": "Pre-formed SirenSeed film bodies to render (films only; images go through create_campaign). Each item: {output_type, channel, seed_body, archetype?, family?, surface?, caption?, voice_id?, music?, direction?, brand_override?}. music = a bed track_id (omit and the bed follows the film and brand). direction = one free line that steers words, pace and music. brand_override with a name = render for ANOTHER brand, clean slate: {name, site, logo_url, primary, accent, secondary, tagline, font, x_handle}.",
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "type": "array"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Human-readable name for the asset or run."
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Store a photo or video the human wants in a post, from an https URL or base64. Returns a workspace-owned URL to put in any media slot of a film body (describe_film lists the slots) — the renderer reads it directly. Images: PNG/JPG/WebP up to 15 MB. Videos: MP4/MOV/WebM up to 200 MB. The same bytes are stored once (content-hashed).

{
  "type": "object",
  "properties": {
    "url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Public https URL of the photo or video to store. Pass this or base64."
    },
    "base64": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "The media bytes as base64, if you have no URL. Pass this or url."
    },
    "kind": {
      "default": "auto",
      "description": "auto (default), image, or video. Detected from the bytes when auto.",
      "type": "string"
    },
    "name": {
      "default": "",
      "description": "Human-readable name for the file.",
      "type": "string"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Post a finished run's assets to the workspace's CONNECTED SOCIAL ACCOUNT. This is live, public distribution on the customer's channel — always confirm with the user before calling. Only works if the grant was authorised with posting allowed. Pass `caption` to own the words; it goes out verbatim. The call queues the post behind a short publish window (about two minutes, cancellable) rather than firing inline: poll get_run after that and read `posts[].url` for the live permalink and the caption that went out.

{
  "type": "object",
  "properties": {
    "run_id": {
      "description": "The run id returned by create_campaign, render_asset, or list_runs.",
      "type": "string"
    },
    "platform": {
      "default": "x",
      "description": "Connected channel to post to: x, instagram, tiktok, linkedin, or youtube.",
      "type": "string"
    },
    "caption": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional caption for this publish; goes out verbatim. Omit and Siren writes it."
    }
  },
  "required": [
    "run_id"
  ],
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Schedule a finished run to post at scheduled_at (ISO-8601). Shows in the customer's local timezone. platforms: x, instagram, tiktok, linkedin, youtube, or everything. Posts fire sequentially. Requires Allow posting. Prefer this over post_run when the user names a time. On create_campaign you can pass scheduled_at instead.

{
  "type": "object",
  "properties": {
    "run_id": {
      "description": "The run id returned by create_campaign, render_asset, or list_runs.",
      "type": "string"
    },
    "scheduled_at": {
      "description": "ISO-8601 time to post, e.g. 2026-09-12T09:00:00. Interpreted in the given timezone.",
      "type": "string"
    },
    "timezone": {
      "default": "UTC",
      "description": "IANA timezone name for scheduled_at, e.g. Africa/Lagos or America/New_York.",
      "type": "string"
    },
    "platforms": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Where to post: any of x, instagram, tiktok, linkedin, youtube, or [\"everything\"] for every connected channel."
    },
    "captions": {
      "anyOf": [
        {
          "additionalProperties": {
            "type": "string"
          },
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional caption override per platform, e.g. {\"x\": \"...\", \"linkedin\": \"...\"}."
    }
  },
  "required": [
    "run_id",
    "scheduled_at"
  ],
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Get this workspace's Brand DNA: brand_name, brand_kind, overview, tagline, offer, features, products, audience, palette, logos, plus `checks`: what to fix before rendering (thin Brand DNA, a typed accent the brand's own work does not use). Call right after get_account; fix thin DNA first with update_brand_dna and upload_product_screen, or ask the human for the site. Not Brand Memory.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Patch Brand DNA. Send only keys to change. Nested bags (offer, product_map, icp) merge. Examples: {tagline, overview, offer: {product_name, one_liner, features, who_its_for, primary_cta}, product_map: {offerings, how_we_work}, icp: {who_buys, pains}}. Does not read or write Brand Memory.

{
  "type": "object",
  "properties": {
    "fields": {
      "additionalProperties": true,
      "description": "Brand DNA keys to change, e.g. {\"tagline\": \"...\", \"offer\": {\"one_liner\": \"...\"}}. Nested bags merge.",
      "type": "object"
    }
  },
  "required": [
    "fields"
  ],
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

List the brand assets in Brand DNA: product photos, app screenshots, packaging. Each row has name, kind, description, use_when, tags, scan_status (scanning / ready / failed), device, theme, url.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Upload a brand asset (product photo, app screenshot, packaging) into Brand DNA and store it on R2. Pass image_url (https PNG/JPG/WebP) or image_base64. Two ways to file it: - Send `description` (and optionally kind, use_when, tags, name): Siren trusts your words and files the asset as-is. No read. - Send only the file: Gemini reads the picture and writes name, kind, description, use_when, tags itself. scan_status goes scanning → ready in about 8 seconds; poll list_product_screens. kind is free text ("product photo", "dashboard screenshot", "packaging"), there is no fixed list. A brief that names an asset ("advertise the pink handbag") pulls that file into the still. screen_type / device / theme only matter for device-framed screenshot masters.

{
  "type": "object",
  "properties": {
    "image_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Public https URL of a PNG, JPG, or WebP to store as a brand asset."
    },
    "image_base64": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "The image bytes as base64, if you have no URL."
    },
    "name": {
      "default": "",
      "description": "Human-readable name for the asset or run.",
      "type": "string"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "What the picture shows and what it is for, in your words. When set, Siren files the asset without reading it."
    },
    "kind": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Free-text kind: product photo, dashboard screenshot, packaging, logo, team photo."
    },
    "use_when": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "When Siren should reach for this asset, e.g. \"any post about the analytics page\"."
    },
    "tags": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Short lowercase tags for search, e.g. [\"dashboard\", \"dark-mode\"]."
    },
    "screen_type": {
      "default": "feature",
      "description": "Screen role: feature, hero, onboarding, settings, or marketing.",
      "type": "string"
    },
    "device": {
      "default": "phone",
      "description": "Device the screenshot was taken on: phone, tablet, desktop, or none.",
      "type": "string"
    },
    "theme": {
      "default": "unknown",
      "description": "UI theme in the screenshot: light, dark, or unknown.",
      "type": "string"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Edit an existing brand asset: name, description, kind, use_when, and the screenshot tags (screen_type, device, theme).

{
  "type": "object",
  "properties": {
    "screen_id": {
      "description": "Id of the brand asset from list_product_screens.",
      "type": "string"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Human-readable name for the asset or run."
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "What the picture shows and what it is for, in your words. When set, Siren files the asset without reading it."
    },
    "kind": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Free-text kind: product photo, dashboard screenshot, packaging, logo, team photo."
    },
    "use_when": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "When Siren should reach for this asset, e.g. \"any post about the analytics page\"."
    },
    "screen_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Screen role: feature, hero, onboarding, settings, or marketing."
    },
    "device": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Device the screenshot was taken on: phone, tablet, desktop, or none."
    },
    "theme": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "UI theme in the screenshot: light, dark, or unknown."
    }
  },
  "required": [
    "screen_id"
  ],
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Remove a product screenshot from Brand DNA. Does not delete Brand Memory.

{
  "type": "object",
  "properties": {
    "screen_id": {
      "description": "Id of the brand asset from list_product_screens.",
      "type": "string"
    }
  },
  "required": [
    "screen_id"
  ],
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Set the workspace logo in Brand DNA. Every render uses it.

{
  "type": "object",
  "properties": {
    "image_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Public https URL of the logo (PNG, JPG or WebP)."
    },
    "image_base64": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "The logo bytes as base64, if you have no URL."
    },
    "variant": {
      "default": "light",
      "description": "light = the mark used on light backgrounds (the usual one); dark = the one for dark backgrounds.",
      "type": "string"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

The workspace mascot: status (hero, keeping, frames, ready), the hero picture, tries left, and every pose frame with its URL. Null mascot = none yet.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Start the brand mascot: from a description (note, kind) or from a reference picture. Paid plans; 100 credits. Siren paints a hero in about a minute; poll get_mascot, show the human, then mascot_step keep (build the pose sheet) or retry (paint again, 3 tries). One mascot per workspace.

{
  "type": "object",
  "properties": {
    "note": {
      "default": "",
      "description": "Describe the character in the human's words: what it is, colours, personality, what to avoid. Up to 280 characters.",
      "type": "string"
    },
    "kind": {
      "default": "auto",
      "description": "auto (Siren picks from the brand), animal, creature, object, robot, food, or abstract.",
      "type": "string"
    },
    "style": {
      "default": "vinyl",
      "description": "Material: vinyl (default), clay, plush, wool, or glossy.",
      "type": "string"
    },
    "name": {
      "default": "",
      "description": "The mascot's name, if the human has one.",
      "type": "string"
    },
    "image_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A reference picture of the mascot (https PNG/JPG/WebP). Siren paints it in the brand's style, keeping the character."
    },
    "image_base64": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "The reference picture as base64, if you have no URL."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Move the mascot on: keep the hero, paint it again, or add a pose. Ask the human before keep, since it builds the whole sheet.

{
  "type": "object",
  "properties": {
    "action": {
      "description": "keep = build the pose sheet from this hero; retry = paint the hero again; pose = add one more pose to a built mascot.",
      "type": "string"
    },
    "note": {
      "default": "",
      "description": "For retry: what to change this time.",
      "type": "string"
    },
    "label": {
      "default": "",
      "description": "For pose: the pose in a few words, e.g. waving, holding a phone.",
      "type": "string"
    },
    "prompt": {
      "default": "",
      "description": "For pose: extra detail for the pose.",
      "type": "string"
    },
    "with_model": {
      "default": false,
      "description": "For pose: also make a 3D model of it (20 credits instead of 10).",
      "type": "boolean"
    }
  },
  "required": [
    "action"
  ],
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

The people library: team faces Siren can put in stills (name, role, team, status cropping or ready, round crop URL).

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Add a face to the people library. Siren crops it round in a few seconds (status cropping, then ready). Only upload people who agreed.

{
  "type": "object",
  "properties": {
    "image_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Public https URL of a portrait (PNG, JPG or WebP), one face."
    },
    "image_base64": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "The portrait as base64, if you have no URL."
    },
    "name": {
      "default": "",
      "description": "The person's name.",
      "type": "string"
    },
    "role": {
      "default": "",
      "description": "Their role, e.g. Founder, Head of Design.",
      "type": "string"
    },
    "team": {
      "default": "",
      "description": "Their team, if any.",
      "type": "string"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Remove a face from the people library.

{
  "type": "object",
  "properties": {
    "person_id": {
      "description": "Id from list_people.",
      "type": "string"
    }
  },
  "required": [
    "person_id"
  ],
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Photos and videos uploaded with upload_media, newest first, with their URLs. Reuse a URL in create_campaign media or a film body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

How the posts did: totals (impressions, engagement, replies, engagement rate) and the top posts with views, likes and replies.

{
  "type": "object",
  "properties": {
    "window": {
      "default": "30d",
      "description": "7d, 30d or 90d.",
      "type": "string"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Every post Siren sent or queued: platform, status, live URL, time, and counts by status (posted, queued, failed).

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 50,
      "description": "How many posts, 1 to 200. Newest first.",
      "type": "integer"
    },
    "offset": {
      "default": 0,
      "description": "Skip this many, to page back.",
      "type": "integer"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Get a Stripe checkout link for more credits. Give the link to the human; they pay on Stripe and the credits land in about a minute. Nothing is charged by this call. Read the balance on get_account.

{
  "type": "object",
  "properties": {
    "pack_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "small (50 credits, $9.99), medium (100, $20) or large (300, $50)."
    },
    "credits": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Or a custom amount, 50 to 5000, at $0.20 each."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

The brand's own clips in Brand DNA: name, what each shows, when to use it, tags, best moments with timestamps, poster and scan_status.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Add a product demo, walkthrough or footage to Brand DNA. With only the file, Gemini reads frames across the clip and writes what it shows, when to use it, tags and the best moments (scan_status scanning, then ready in about 15 seconds; poll list_brand_videos). Films play it when a brief names it ("launch film with our checkout demo"). Videos are for films; stills are painted from pictures.

{
  "type": "object",
  "properties": {
    "url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Public https URL of the clip (MP4, MOV or WebM, up to 200 MB and 5 minutes)."
    },
    "base64": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "The clip bytes as base64, if you have no URL."
    },
    "name": {
      "default": "",
      "description": "Human-readable name, e.g. \"checkout demo\".",
      "type": "string"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "What the clip shows, in your words. When set, Siren files it without reading it."
    },
    "use_when": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "When a film should play it, e.g. \"any film about checkout\"."
    },
    "tags": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Short lowercase search words."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Remove a clip from Brand DNA, file and poster included.

{
  "type": "object",
  "properties": {
    "video_id": {
      "description": "Id from list_brand_videos.",
      "type": "string"
    }
  },
  "required": [
    "video_id"
  ],
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Delete one photo or video uploaded with upload_media. Only this workspace's uploads; a film that already rendered keeps its copy.

{
  "type": "object",
  "properties": {
    "url": {
      "description": "The URL upload_media returned (or one from list_media).",
      "type": "string"
    }
  },
  "required": [
    "url"
  ],
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

List Siren Studio's 33 React data-card types with family, description, and body schema. Use this before studio_card so the body matches.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Render a Studio data card from a type + body. Deterministic React, no paint. Optional live post after render. Returns run_id, image url, and post url when posted.

{
  "type": "object",
  "properties": {
    "output_type": {
      "description": "One of the 33 Studio types from studio_templates, e.g. sale-notification.",
      "type": "string"
    },
    "body": {
      "additionalProperties": true,
      "description": "Card fields for that type (amount, productName, …).",
      "type": "object"
    },
    "theme": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "dark or light. Omit to use the workspace default."
    },
    "accent": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Hex accent, e.g. #5B82FF."
    },
    "aspect": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Canvas aspect, e.g. square-ig or wide-twitter."
    },
    "post": {
      "default": false,
      "description": "If true, post the finished card to a connected account. Confirm with the user first.",
      "type": "boolean"
    },
    "caption": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Caption when posting."
    },
    "platform": {
      "default": "x",
      "description": "Connected channel if post is true: x, instagram, tiktok, linkedin, or youtube.",
      "type": "string"
    }
  },
  "required": [
    "output_type",
    "body"
  ],
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Create a Studio profile on this API key. Returns generate curl and inbound hook URLs (Stripe, GitHub, Uptime Kuma, Product Hunt, generic). Passing delivery.social_account_ids turns on social delivery for the profile — that publishes, so it requires Allow posting.

{
  "type": "object",
  "properties": {
    "name": {
      "description": "Name for this automation profile.",
      "type": "string"
    },
    "output_types": {
      "description": "Studio types this profile may render.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "delivery": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional delivery: {social_account_ids?, telegram?, discord?}."
    },
    "caption": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Default caption for auto-posted cards."
    }
  },
  "required": [
    "name",
    "output_types"
  ],
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Render a Studio card then queue a ScheduledPost at scheduled_at.

{
  "type": "object",
  "properties": {
    "output_type": {
      "description": "Studio type to render.",
      "type": "string"
    },
    "body": {
      "additionalProperties": true,
      "description": "Card fields for that type.",
      "type": "object"
    },
    "scheduled_at": {
      "description": "ISO-8601 time to post.",
      "type": "string"
    },
    "platforms": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "x, instagram, tiktok, linkedin, youtube, or everything."
    },
    "caption": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Caption for the scheduled post."
    },
    "timezone": {
      "default": "UTC",
      "description": "IANA timezone for scheduled_at.",
      "type": "string"
    }
  },
  "required": [
    "output_type",
    "body",
    "scheduled_at"
  ],
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}