CountLink

{'type': 'object', 'required': ['segments'], 'properties': {'segments': {'type': 'array', 'items': {'type': 'object', 'required': ['duration'], 'properties': {'label': {'type': 'string', 'description': 'Optional name for the segment, e.g. "Intro" or "Break". Keep it short.'}, 'duration': {'type': 'string', 'description': 'How long the timer runs. Accepts "25m", "1h30m", "90s", "5:00", "1:30:00", or a plain number read as minutes ("45"). A setup link or OBS overlay holds up to 99h59m59s. With start_now or embed_on_website, longer countdowns of up to 366 days are fine: "10d", "10 days", "10d 6h" or "240h".'}}}, 'maxItems': 24, 'minItems': 1, 'description': 'The segments in running order. Each has a duration (same grammar as create_timer: "10m", "1h", "90s", "5:00", or a plain number of minutes) and an optional short label. 1–24 segments; the whole agenda must fit in 99h59m59s.'}, 'start_at': {'type': 'string', 'description': 'Optional ISO-8601 instant for a scheduled start, e.g. "2026-09-08T09:15:00Z" or with a local offset like "2026-09-08T09:15:00+01:00". Omit to start immediately. A start_at already in the past is just treated as already running from that instant.'}}}

{'type': 'object', 'required': ['duration'], 'properties': {'label': {'type': 'string', 'description': 'Optional short name shown on the badge, e.g. "Launch" or "CFP closes".'}, 'duration': {'type': 'string', 'description': 'How long the timer runs. Accepts "25m", "1h30m", "90s", "5:00", "1:30:00", or a plain number read as minutes ("45"). A setup link or OBS overlay holds up to 99h59m59s. With start_now or embed_on_website, longer countdowns of up to 366 days are fine: "10d", "10 days", "10d 6h" or "240h".'}, 'badge_style': {'enum': ['board', 'minimal', 'light'], 'type': 'string', 'description': 'Visual style: "board" (default, dark), "minimal" (no background — blends into any page) or "light".'}}}

{'type': 'object', 'required': ['duration'], 'properties': {'label': {'type': 'string', 'description': 'Optional name shown on the board, e.g. "Exam" or "Break". Keep it short.'}, 'duration': {'type': 'string', 'description': 'How long the timer runs. Accepts "25m", "1h30m", "90s", "5:00", "1:30:00", or a plain number read as minutes ("45"). A setup link or OBS overlay holds up to 99h59m59s. With start_now or embed_on_website, longer countdowns of up to 366 days are fine: "10d", "10 days", "10d 6h" or "240h".'}, 'start_now': {'type': 'boolean', 'default': False, 'description': 'False (default) returns a setup link the user starts themselves — correct for a timer that should begin later, and for anything being written down in advance. True returns a link for a countdown already running from now, fixed to one instant so every viewer is in sync; only use it when the timer should start immediately.'}, 'embed_style': {'enum': ['board', 'minimal', 'light'], 'type': 'string', 'description': 'Board style for embed_on_website: "board" (default, dark split-flap), "minimal" (plain digits) or "light". Ignored otherwise.'}, 'embed_width': {'type': 'number', 'description': 'Pixel width of the embedded iframe when embed_on_website is true. 160–1600, default 400. Ignored otherwise.'}, 'embed_height': {'type': 'number', 'description': 'Pixel height of the embedded iframe when embed_on_website is true. 80–900, default 160. Ignored otherwise.'}, 'for_obs_overlay': {'type': 'boolean', 'default': False, 'description': 'True returns a URL to paste into OBS (or any streaming tool) as a Browser Source: a transparent background with just the digits, which starts counting as soon as the scene loads. Use it when someone wants a countdown on their stream. Do not give an overlay URL to several people to open — it starts fresh for whoever loads it; for that, call this again without the flag and share that link instead. Mutually exclusive with embed_on_website.'}, 'embed_on_website': {'type': 'boolean', 'default': False, 'description': "True returns ready-to-paste <iframe> HTML for embedding a countdown on someone's OWN website or landing page — e.g. a launch-day countdown on a marketing page. Unlike for_obs_overlay, this is a fixed instant every visitor to that page sees identically (not a per-visitor restart), and free with no watermark option — the only requirement is a small attribution line under the widget linking back to CountLink, which the returned HTML already includes. Use this whenever someone asks for a countdown to put ON their own site/page, as opposed to a link to share with other people directly. Mutually exclusive with for_obs_overlay."}}}

{'type': 'object', 'required': ['url'], 'properties': {'url': {'type': 'string', 'description': 'A countlink.app timer URL.'}}}