Assistant documentation
Assistant tools
Use the shipped Playflow assistant with your current workspace permissions.
Shipped registry
This inventory is generated at build time from the same registry used by MCP and Ask Playflow. Plans describe the assistant gate; underlying feature entitlements, limits and the listed permissions still apply. Write means preview and Confirm, not an immediate unreviewed mutation. Refusal guidance is read-only.
| Tool | Assistant plans | Access | Description |
|---|---|---|---|
analytics_ | Trial, Harbor, Marina, Fleet | Read | Compares an inclusive UTC window with the immediately preceding equal-length UTC window. Returns current, previous, absolute change, and percent change per metric; percentChange is percentage units and is null with zero_baseline when the prior value is zero. Rate values and their absolute deltas are decimal ratios; averagePercentWatched is percentage units; watch time is seconds. uniqueSessions counts played sessions and is not a unique-viewer count. Owner distinct viewers are unavailable. No raw events, viewer identities, or transcripts are returned. Use organizationId "all" to read every separately authorized workspace; results name their workspace. Continue with nextWorkspaceCursor when the bounded response has more workspaces. Requires analytics.read. |
analytics_ | Trial, Harbor, Marina, Fleet | Read | Lists country, region, or city analytics ranked by plays for an inclusive UTC range. averagePercentWatched is in percentage units. Owner distinct viewers are unavailable; member viewers are null when retained identity coverage cannot support an exact count. Team playback is excluded by default. No raw locations, events, viewer identities, or transcripts are returned. Use organizationId "all" to read every separately authorized workspace; results name their workspace. Continue with nextWorkspaceCursor when the bounded response has more workspaces. Requires analytics.read. |
analytics_ | Trial, Harbor, Marina, Fleet | Read | Loads versus plays and play rate for a video, loosely named folder, workspace or All member workspaces. Each website/embed host, watch/share pages and in-app member previews are separate. In-app previews are never website loads. Returns background loads, clicked plays, autoplay starts and unclassified historical starts. Pass the user's period. Omit selectors for a workspace total. Use organizationId "all" to read every separately authorized workspace; results name their workspace. Continue with nextWorkspaceCursor when the bounded response has more workspaces. Requires analytics.read. |
analytics_ | Trial, Harbor, Marina, Fleet | Read | Returns bounded daily analytics totals for a workspace or, for owners, the platform aggregate. Watch time and averages are seconds; averagePercentWatched is percentage units, while playRate and completionRate are decimal ratios. Owner reports omit distinct-viewer counts because the platform role cannot read raw playback identity, but uniqueSessions remains available. It never returns raw playback events, viewer identities, or transcript data. Use organizationId "all" to read every separately authorized workspace; results name their workspace. Continue with nextWorkspaceCursor when the bounded response has more workspaces. Requires analytics.read. |
analytics_ | Trial, Harbor, Marina, Fleet | Read | Lists attributed playback sources and embed hosts with aggregate loads, plays, unique sessions, watch time in seconds, completions, averagePercentWatched in percentage units, and other rates as decimal ratios. Owner distinct viewers are unavailable. unknown means attribution was not retained; team playback is excluded by default. It returns no raw referrer URLs, events, viewer identities, or transcripts. Use organizationId "all" to read every separately authorized workspace; results name their workspace. Continue with nextWorkspaceCursor when the bounded response has more workspaces. Requires analytics.read. |
analytics_ | Trial, Harbor, Marina, Fleet | Read | Lists videos ranked by plays for an inclusive UTC range, with loads, plays, played unique sessions, distinct retained viewers where available, watch time in seconds, completions, and decimal rates. Unique sessions are not unique viewers. Team playback is excluded unless includeTeam is true. No raw events, viewer identities, or transcripts are returned. Use organizationId "all" to read every separately authorized workspace; results name their workspace. Continue with nextWorkspaceCursor when the bounded response has more workspaces. Requires analytics.read. |
analytics_ | Trial, Harbor, Marina, Fleet | Read | Video performance by title or videoId within scope. Returns covered UTC range, plays, completion rate, watch time, average percent watched, sources and app links. Ambiguous titles return choices. includeDetails adds retention/entitlement-gated daily, overlay and engagement reports; rates are ratios. No viewer identities or raw events. Use organizationId "all" to read every separately authorized workspace; results name their workspace. Continue with nextWorkspaceCursor when the bounded response has more workspaces. Requires analytics.read. |
assistant_ | Trial, Harbor, Marina, Fleet | Read | Explains actions never allowed through the assistant and links to the app. Never mutates data. |
assistant_ | Trial, Harbor, Marina, Fleet | Read | Lists bounded assistant tool-call telemetry: tool, status, surface, row and byte counts, truncation, and latency in milliseconds. Members see only their selected workspace; owners may see all rows or one workspace. Excludes tool arguments, prompts, answers, credentials, client IDs, conversation IDs, and request IDs. Use organizationId "all" to read every separately authorized workspace; results name their workspace. Continue with nextWorkspaceCursor when the bounded response has more workspaces. |
assistant_ | Marina, Fleet | Write | Apply exactly one preview using its one-time token, within ten minutes. Rechecks plan, role, workspace and settings revision inside the transaction. Requires videos.update. |
assistant_ | Trial, Harbor, Marina, Fleet | Read | Returns credits left, monthly allowance, purchased credits, reset date and plan for one workspace. In All workspaces, use the active workspace for a credits question. MCP itself uses no credits. Use organizationId "all" to read every separately authorized workspace; results name their workspace. Continue with nextWorkspaceCursor when the bounded response has more workspaces. |
assistant_ | Marina, Fleet | Write | Preview restoring a saved settings change, within seven days. Use its undoHandle as changeSetId. This returns a new confirmation token; call assistant_confirm to restore. Never overwrites newer settings. Requires videos.update. |
audit_ | Trial, Harbor, Marina, Fleet | Read | Searches one workspace's audit ledger. Date bounds are inclusive UTC calendar days. Returns identity references and a small allowlist of non-secret metadata, but excludes before/after payloads, credentials, tokens, request IDs, and unapproved metadata. Use organizationId "all" to read every separately authorized workspace; results name their workspace. Continue with nextWorkspaceCursor when the bounded response has more workspaces. Requires audit.read. |
billing_ | Platform administrators | Read | Lists stored billing receipt metadata and processing outcomes for inclusive UTC dates, optionally for one workspace. Owner-only. Attempts are counts; excludes provider payloads, provider object/customer/subscription IDs, processing claims, payment details, credentials, and mutations. |
contact_ | Platform administrators | Read | Lists bounded contact-request workflow records with the submitter-provided contact and message fields. Owner-only. Times are UTC; excludes visitor IP, user agent, arbitrary submitted fields, internal notes, and all mutations. |
costs_ | Platform administrators | Read | Summarizes stored daily provider bandwidth cost plus LLM and transcription usage for inclusive UTC dates, optionally for one workspace. Owner-only. Costs are micro-USD, bandwidth is bytes, audio is seconds, and token values are counts; storage/transcoding and unregistered libraries are excluded where marked unavailable. |
docs_ | Trial, Harbor, Marina, Fleet | Read | Read current help documentation. Continue with nextOffset when present. Operator docs require a current operator-tier grant. |
docs_ | Trial, Harbor, Marina, Fleet | Read | Search the current customer help docs and, with operator authority, the operator guide. |
edge_ | Platform administrators | Read | Lists stored edge publication states, pending intents, and the latest observed dispatch update, optionally for one workspace. Owner-only. Attempts are counts and times are UTC; excludes object contents, fingerprints, ETags, claims, manifests, raw playback, and all mutations. |
folders_ | Trial, Harbor, Marina, Fleet | Read | Lists folders in one workspace with parent IDs and direct video counts (videos immediately in each folder, not descendants). Dates are UTC timestamps. Excludes video contents, transcripts, and storage/provider identifiers. Use organizationId "all" to read every separately authorized workspace; results name their workspace. Continue with nextWorkspaceCursor when the bounded response has more workspaces. Requires videos.read. |
jobs_ | Platform administrators | Read | Summarizes failed jobs by queue name for a bounded window and returns each queue's latest redacted, size-limited failure output. Owner-only; job inputs and credentials are never returned. |
library_ | Marina, Fleet | Write | Preview one workspace's multi-video cleanup: rename, add or remove tags and move folders only. Marina allows 100 videos and Fleet 300, with per-video failure isolation. Nothing is copied, deleted or archived. Requires videos.update. |
library_ | Trial, Harbor, Marina, Fleet | Read | Exact total video count, per-status counts, folder counts and unfiled count from COUNT queries, independent of search pages. Use for how many videos or folders questions. Use organizationId "all" to read every separately authorized workspace; results name their workspace. Continue with nextWorkspaceCursor when the bounded response has more workspaces. Requires videos.read. |
member_ | Marina, Fleet | Write | Owners preview a normal member invitation. Missing name, email or role returns needs for the inline form. Undo revokes the invitation only while pending. Workspace Owners only. Requires members.manage. |
member_ | Marina, Fleet | Write | Owners preview and confirm resend of a pending invitation in one workspace. Never removes members or changes their roles. Workspace Owners only. Requires members.manage. |
member_ | Marina, Fleet | Write | Owners preview and confirm revoke of a pending invitation in one workspace. Never removes members or changes their roles. Workspace Owners only. Requires members.manage. |
operator_ | Platform administrators | Read | Lists owner-only login and heartbeat activity for inclusive UTC calendar days (maximum 32 days). Location is coarse retained activity data; no raw user agent, session hash, credentials, token, or exact IP address is returned. |
operator_ | Platform administrators | Write | Platform administrators preview and confirm resending one pending invitation through the existing operator route. The operator is the audit actor. |
operator_ | Platform administrators | Write | Platform administrators preview and confirm extending an existing Trial by 1 to 365 days through the operator action. Never reopens a paid plan or changes billing. |
operator_ | Platform administrators | Write | Platform administrators preview and confirm republishing only one selected video's edge publication through the existing operator route. |
performance_ | Trial, Harbor, Marina, Fleet | Read | Recap a period versus the previous equal-length period: plays, watch time in seconds, completion, top videos, biggest movers and sources. Text or a CSV download. Workspace empty periods return zero. Use organizationId "all" to read every separately authorized workspace; results name their workspace. Continue with nextWorkspaceCursor when the bounded response has more workspaces. Requires analytics.read. |
platform_ | Platform administrators | Read | Searches the owner-only platform audit ledger over inclusive UTC calendar-day bounds. Returns a bounded allowlist of non-secret metadata; excludes before/after payloads, credentials, tokens, request IDs, and unapproved metadata. |
playflow_ | Trial, Harbor, Marina, Fleet | Read | Read Playflow product features, plans, entitlements, and unavailable features. It does not return customer data. |
playflow_ | Trial, Harbor, Marina, Fleet | Read | Read precise Playflow analytics metric and playback-source definitions. |
playflow_ | Platform administrators | Read | Read platform administration guidance without secrets or customer data. Requires current platform admin authority and an operator-tier grant. |
playflow_ | Trial, Harbor, Marina, Fleet | Read | Find canonical Playflow marketing, documentation, app, API, and playback paths. |
provider_ | Platform administrators | Read | Returns stored provider account capacity, tenant-space lifecycle state, and videos stale in processing. Owner-only. Capacity is tenant spaces and staleHours is hours; makes no provider API calls and excludes credentials, provider IDs, metadata, claims, and secrets. |
signup_ | Platform administrators | Read | Aggregates non-bot signup funnel events by step, signup method, country, and intended plan for inclusive UTC dates. Owner-only. Values are event counts, not unique people or inferred conversions; excludes visitor/session IDs, IPs, domains, user agents, paths, and raw events. |
storage_ | Platform administrators | Read | Lists workspace storage usage, 80/90 percent crossing state, and redacted notification status. Owner-only. Usage is bytes, limits are decimal GB, and ratios are percent; excludes recipient addresses, notification error text, credentials, and writes. |
tenant_ | Platform administrators | Read | Returns one workspace's billing lifecycle, access state and non-secret subscription projection. Owner-only; it never returns payment details or provider credentials. |
tenant_ | Platform administrators | Read | Returns one workspace's operational profile and bounded counts. Owner-only; it does not return secrets, provider credentials, or member identities. |
tenant_ | Platform administrators | Read | Returns effective plan entitlements for one workspace. Owner-only; it does not expose overrides outside the requested workspace. |
tenants_ | Platform administrators | Read | Lists Playflow workspaces with plan, trial, storage, member and video summaries. Owner-only; it does not expose member identities or billing credentials. |
transcript_ | Trial, Harbor, Marina, Fleet | Read | Search stored transcript text in one video, one workspace or all authorized workspaces. Returns timestamps, short snippets and time links. Never includes speaker names. Use organizationId "all" to read every separately authorized workspace; results name their workspace. Continue with nextWorkspaceCursor when the bounded response has more workspaces. Requires videos.read. |
video_ | Marina, Fleet | Write | Preview generation of transcripts and captions with an optional language, or chapters from an existing transcript. Shows caption minutes and videos that fit. Generated content is Not undone by Undo and stays in the library. Requires videos.update. |
video_ | Trial, Harbor, Marina, Fleet | Read | Returns one workspace video's lifecycle and provider-state flags, media measurements (seconds, pixels, frames/second, bits/second, bytes), identity overrides, playback options, domain rules, password-set boolean, and caption/chapter presence. Excludes transcript text, password hashes, credentials, storage keys, and private provider identifiers. Use organizationId "all" to read every separately authorized workspace; results name their workspace. Continue with nextWorkspaceCursor when the bounded response has more workspaces. Requires videos.read. |
video_ | Marina, Fleet | Write | Preview allowed and blocked playback domains using the editor's domain rules. Requires videos.update. |
video_ | Trial, Harbor, Marina, Fleet | Read | Return a signed short-lived original download link where the workspace plan and download permission allow it. Use organizationId "all" to read every separately authorized workspace; results name their workspace. Continue with nextWorkspaceCursor when the bounded response has more workspaces. Requires videos.read. |
video_ | Marina, Fleet | Write | Preview buttons and hotspots using the editor's text, position, timing, link and workspace-style contract. Replaces the listed video's interactive document. Always preview then confirm. Requires videos.update. |
video_ | Marina, Fleet | Write | Preview video title, description and folder changes. Nothing is deleted or archived. Requires videos.update. |
video_ | Marina, Fleet | Write | Preview per-video playback and visual identity overrides. Null resets an override to Use workspace default. Includes the per-video logo link URL. No picture or sound edits. Requires videos.update. |
video_ | Marina, Fleet | Write | Preview setting, changing or removing the password for public or unlisted video links. Null removes protection. Password values are never returned in previews. Requires videos.update. |
video_ | Marina, Fleet | Write | Preview replacement upload credentials using the app's replace flow and daily cap. Undo uses the existing 48-hour restore after completion. Requires videos.update. |
video_ | Trial, Harbor, Marina, Fleet | Read | Read the existing video sharing boundary's share URL, iframe snippet and workspace embed.js snippet. Read-only for every assistant plan. Private videos remain private. Use organizationId "all" to read every separately authorized workspace; results name their workspace. Continue with nextWorkspaceCursor when the bounded response has more workspaces. Requires videos.read. |
video_ | Trial, Harbor, Marina, Fleet | Read | Read upload and processing status in plain words. Include the returned uploadId to inspect a replacement upload. Use organizationId "all" to read every separately authorized workspace; results name their workspace. Continue with nextWorkspaceCursor when the bounded response has more workspaces. Requires videos.read. |
video_ | Marina, Fleet | Write | Preview a thumbnail from a private image attachment, public HTTPS image URL, or exact frame at timeSeconds. Confirm saves it; confirmed Undo restores the prior thumbnail. Requires videos.update. |
video_ | Marina, Fleet | Write | Preview a resumable upload, including today's assistant cap. Confirm returns upload credentials; video bytes never enter chat. Requires videos.create. |
video_ | Marina, Fleet | Write | Preview visibility from intent: public, unlisted or private. Requires videos.update. |
videos_ | Trial, Harbor, Marina, Fleet | Read | Database count and bounded list of videos with no ready, nonempty caption track. Use for videos missing or without captions. Use organizationId "all" to read every separately authorized workspace; results name their workspace. Continue with nextWorkspaceCursor when the bounded response has more workspaces. Requires videos.read. |
videos_ | Trial, Harbor, Marina, Fleet | Read | Searches video metadata by title, lifecycle, visibility, folder, tags and creation dates. It returns no playback events, transcript text, storage keys, or provider identifiers. Use organizationId "all" to read every separately authorized workspace; results name their workspace. Continue with nextWorkspaceCursor when the bounded response has more workspaces. Requires videos.read. |
workspace_ | Marina, Fleet | Write | Preview workspace player colors (hex or named palette), cover treatment, control bar style, page restyling, watermark position/size/opacity and logo/watermark link URLs with tracking. Does not upload or fetch images. Requires Marina or Fleet and videos.update. Confirm the returned token to save. Requires videos.update. |
workspace_ | Marina, Fleet | Write | Discover a public domain's brand through the existing queued discovery service and preview its contrast-safe player palette. If discovery is pending, call again later. No logo or watermark image import. Always preview then confirm. Requires videos.update. |
workspace_ | Marina, Fleet | Write | Preview a workspace logo from a private attachment or public HTTPS image URL. Optional link URL and UTM tracking use the editor contract. Requires Marina or Fleet and videos.update. Confirm saves; confirmed Undo restores the prior asset and links. Requires videos.update. |
workspace_ | Marina, Fleet | Write | Preview starting quality, autoplay, loop, remembering sound choices, title, center Play/Replay modes, positions and sizes, and Standard/Background playback defaults. Does not edit video picture or sound. Requires Marina or Fleet and videos.update. Always preview then confirm. Requires videos.update. |
workspace_ | Trial, Harbor, Marina, Fleet | Read | Read the current workspace plan name, trial end date and days left, lifecycle state, payment method on file yes/no and what that state means. No amounts, card details or invoices. Use organizationId "all" to read every separately authorized workspace; results name their workspace. Continue with nextWorkspaceCursor when the bounded response has more workspaces. |
workspace_ | Marina, Fleet | Write | Preview a workspace watermark from a private attachment or public HTTPS image URL. Optional link URL and UTM tracking use the editor contract. Requires Marina or Fleet and videos.update. Confirm saves; confirmed Undo restores the prior asset and links. Requires videos.update. |
Platform-administrator entries are not available to tenant clients. Listing their registry metadata does not expose the private operator guide or grant operator authority. Workspace-scoped administrator changes still obey the workspace boundary and applicable plan checks.
Plan and role checks
Trial and Harbor can ask questions; Marina and Fleet can make permitted changes. Viewers remain read-only. Tools requiring workspace ownership or a named permission check it server-side. A change set never combines workspaces. Refused actions are not an alternative mutation path.
For connection instructions, read Connect an assistant. For current commercial plans, see Pricing.