Capture

Read bounded recent recording activity and 30-day watched-viewer/comment counts, respecting account and personal access. Viewer sessions are not verified people. No messages are sent.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.activity \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 6,
    "scope": "activity"
  }'

Over MCP the same operation is the tool capture_activity at https://app.chirply.io/api/mcp, same bearer token, same input.

Count anonymous viewer sessions, plays and completions. Completion requires at least 90% non-overlapping watched coverage reported by the browser; sessions are not verified unique people. No messages are sent.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.analytics \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_analytics at https://app.chirply.io/api/mcp, same bearer token, same input.

Append four editable SOP, onboarding or troubleshooting prompts to the guide. Prompts are illustrative placeholders, not generated facts. Saves immediately and changes existing shared guides; no messages are sent.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.append_guide_template \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "template": "sop"
  }'

Over MCP the same operation is the tool capture_append_guide_template at https://app.chirply.io/api/mcp, same bearer token, same input.

List connected Facebook profiles, Facebook Pages and YouTube channels available for automatic live setup, including whether each connection needs renewed live permissions. No credentials are returned.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.broadcast_connections \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Over MCP the same operation is the tool capture_broadcast_connections at https://app.chirply.io/api/mcp, same bearer token, same input.

Save an encrypted Facebook, YouTube, Restream or Twitch stream key for future broadcasts. No video is transmitted until a broadcast is explicitly started.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.broadcast_destination_add \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Example",
    "platform": "facebook",
    "server_url": "https://example.com",
    "stream_key": "example"
  }'

Over MCP the same operation is the tool capture_broadcast_destination_add at https://app.chirply.io/api/mcp, same bearer token, same input.

Save a connected Facebook profile, Page or YouTube channel as a live destination without manually entering a stream key. Does not create a broadcast until Go live is explicitly requested.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.broadcast_destination_connect \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "kind": "facebook_profile",
    "connection_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_broadcast_destination_connect at https://app.chirply.io/api/mcp, same bearer token, same input.

Delete a saved live destination and encrypted stream key from this account. Active broadcasts keep their existing destination snapshot until stopped.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.broadcast_destination_remove \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_broadcast_destination_remove at https://app.chirply.io/api/mcp, same bearer token, same input.

Read live destinations, relay configuration, current managed rate and recent account broadcast sessions. Stream keys and relay credentials are never returned.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.broadcast_overview \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Over MCP the same operation is the tool capture_broadcast_overview at https://app.chirply.io/api/mcp, same bearer token, same input.

Get the customer relay package and deployment instructions for hosting Capture streaming in your own Cloudflare account. Downloading is free; deploying and streaming incur your provider’s hosting and traffic charges.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.broadcast_relay_package \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Over MCP the same operation is the tool capture_broadcast_relay_package at https://app.chirply.io/api/mcp, same bearer token, same input.

Choose managed streaming billed against account credits or a customer-owned Capture relay billed by its host. Saves encrypted credentials; does not start a broadcast.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.broadcast_settings \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "mode": "managed"
  }'

Over MCP the same operation is the tool capture_broadcast_settings at https://app.chirply.io/api/mcp, same bearer token, same input.

Reserve the reviewed maximum managed-streaming cost and prepare up to five live destinations with the selected audience; Facebook Pages are public. Returns a short-lived ingest URL. A browser must explicitly share its screen and send media; custom relays use their own provider billing.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.broadcast_start \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "request_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "title": "Example",
    "destination_ids": [
      "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
    ],
    "max_minutes": 1,
    "expected_rate_cents": 1
  }'

Over MCP the same operation is the tool capture_broadcast_start at https://app.chirply.io/api/mcp, same bearer token, same input.

Reconcile a live session with its relay and read destination health and metered duration. Completed sessions return unused reserved account credit exactly once.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.broadcast_status \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_broadcast_status at https://app.chirply.io/api/mcp, same bearer token, same input.

Stop this live broadcast on all selected destinations and settle managed streaming usage, returning unused reserved credits. Videos already delivered to platforms remain there.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.broadcast_stop \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_broadcast_stop at https://app.chirply.io/api/mcp, same bearer token, same input.

Create the reviewed product and price in the selected account Stripe mode and prepare a draft sales page with the shared video and native checkout. Requires explicit price, currency and billing terms. Charges nobody now and leaves the page unpublished; publishing it permits real purchases in live mode.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.build_offer \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "offer_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "draft": {
      "name": "Example",
      "headline": "example",
      "summary": "example",
      "deliverables": [
        "example"
      ],
      "price_amount": 50,
      "currency": "USD",
      "billing": "one_time",
      "terms": "example",
      "price_evidence": "example",
      "questions": [
        "example"
      ]
    },
    "payment_mode": "test",
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_build_offer at https://app.chirply.io/api/mcp, same bearer token, same input.

Stop a queued or running render from publishing its edited copy. Original recordings remain intact; delete the unfinished output separately to release reserved storage. Completed jobs are returned unchanged and no messages are sent.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.cancel_render \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_cancel_render at https://app.chirply.io/api/mcp, same bearer token, same input.

Assign an ownerless legacy recording to the signed-in account manager. Future enabled watch/comment notifications go to that person; existing ownership cannot be replaced. Requires an identified user and does not immediately send messages.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.claim \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_claim at https://app.chirply.io/api/mcp, same bearer token, same input.

Post a visible recording comment or reply. Existing public viewers can read it, and the recording owner may receive an in-app alert, email and browser push according to preferences. Email provider fees may apply.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.comment \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "body": "example",
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_comment at https://app.chirply.io/api/mcp, same bearer token, same input.

Connect an already-owned hostname for public videos, screenshots and guides, and provision TLS. Includes ten Capture-only domains on Spark through Grow and unlimited on Scale and Founder; does not buy a domain, alter DNS records or unlock the white-label app. Returns CNAME instructions for your DNS provider.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.connect_domain \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "example"
  }'

Over MCP the same operation is the tool capture_connect_domain at https://app.chirply.io/api/mcp, same bearer token, same input.

Create a private Capture draft for an imported video or browser recording. Upload media separately; creating a draft does not record a person's screen or publish anything.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.create \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "access": "workspace",
    "folder": "example"
  }'

Over MCP the same operation is the tool capture_create at https://app.chirply.io/api/mcp, same bearer token, same input.

Create a personal or account video playlist. Account collections are visible to account members, but grant no recording permissions and send no messages.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.create_collection \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Example"
  }'

Over MCP the same operation is the tool capture_create_collection at https://app.chirply.io/api/mcp, same bearer token, same input.

Create a ten-minute one-time code that connects a browser to this account's included Capture recorder. The credential can read and manage account Capture recordings, including edits, sharing, deletion and separately invoked AI operations that bill connected providers. It grants no paid Browser Agent tasks, manager controls or personal-recording access. Creating the code incurs no charge; keep it private.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.create_pairing \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Over MCP the same operation is the tool capture_create_pairing at https://app.chirply.io/api/mcp, same bearer token, same input.

Permanently delete a recording, its stored video, guide and viewer events. This cannot be undone and existing share links stop working.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.delete \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_delete at https://app.chirply.io/api/mcp, same bearer token, same input.

Permanently delete a video collection and its playlist ordering. This cannot be undone; source recordings remain and no messages are sent.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.delete_collection \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_delete_collection at https://app.chirply.io/api/mcp, same bearer token, same input.

Remove the acting author's comment body and displayed author identity, preserving a deleted-comment placeholder and replies. This cannot restore the original text and does not retract copies already delivered to readers.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.delete_comment \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "comment_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_delete_comment at https://app.chirply.io/api/mcp, same bearer token, same input.

Remove a Capture-only hostname and its TLS provisioning. Existing links on that hostname stop working; recordings remain available on the platform. Does not delete recordings or remove shared app domains. Stored domain preferences fall back to an available host.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.disconnect_domain \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_disconnect_domain at https://app.chirply.io/api/mcp, same bearer token, same input.

Get the authenticated download endpoint for the stored original video. Send your existing API Bearer credential when fetching it; the URL is private and does not publish content.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.download \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_download at https://app.chirply.io/api/mcp, same bearer token, same input.

Send up to twelve reviewed screenshots and optional context to the account's connected vision provider, which bills for processing. Returns an evidence-based editable draft without saving or publishing it. Reuse the same request ID and identical input to retrieve an outcome without repeating generation; an uncertain provider outcome may already have incurred a charge.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.draft_visual_guide \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "request_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "model": "example",
    "frames": [
      {
        "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
        "timestamp_ms": 1,
        "jpeg_base64": "example"
      }
    ],
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_draft_visual_guide at https://app.chirply.io/api/mcp, same bearer token, same input.

Edit a comment authored by the acting user or this account's API integration. Changes affect existing public readers; editing does not resend the original comment notification. Guest authors use their signed viewer ticket through the public recording endpoint.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.edit_comment \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "body": "example",
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "comment_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_edit_comment at https://app.chirply.io/api/mcp, same bearer token, same input.

Encode selected source clips into a new MP4, WebM or GIF recording. Consumes server compute and reserves account storage up to max_output_bytes; no original is changed and no messages are sent. Failed copies keep their reservation until deleted; reuse the same request_id only for identical input.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.enqueue_render \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "request_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "title": "Example",
    "plan": {
      "clips": [
        {
          "project_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
          "start_ms": 1,
          "end_ms": 1
        }
      ]
    }
  }'

Over MCP the same operation is the tool capture_enqueue_render at https://app.chirply.io/api/mcp, same bearer token, same input.

Export a portable Markdown or HTML guide with authenticated screenshots embedded as JPEG data. Includes up to 20 MiB of images; the resulting file contains recording content and can be shared outside Chirply. Does not publish or send it.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.export_guide \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_export_guide at https://app.chirply.io/api/mcp, same bearer token, same input.

Open Facebook consent to connect a personal profile for Capture live streaming and video publishing. Requires a signed-in person and Meta app permission approval. This operation publishes no content.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.facebook_profile_connect \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Over MCP the same operation is the tool capture_facebook_profile_connect at https://app.chirply.io/api/mcp, same bearer token, same input.

Remove this account’s encrypted Facebook profile token and its saved automatic live destination. Future publishing stops; existing Facebook videos remain on Facebook.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.facebook_profile_disconnect \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_facebook_profile_disconnect at https://app.chirply.io/api/mcp, same bearer token, same input.

Complete a previously uploaded private recording after every multipart receipt is verified. Makes the stored original playable inside the account without publishing or messaging anyone.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.finalize_upload \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "parts": [
      {
        "part_number": 1,
        "etag": "example"
      }
    ],
    "duration_ms": 1,
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_finalize_upload at https://app.chirply.io/api/mcp, same bearer token, same input.

Subscribe an account member to visible replies in a recording discussion. Enabled email and push channels send real notifications and email provider fees may apply. Every delivery rechecks membership, recording privacy and the subscription.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.follow_thread \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "comment_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_follow_thread at https://app.chirply.io/api/mcp, same bearer token, same input.

Create an editable guide from captured events or an AI interpretation of the transcript. If needed, transcribes the video through the account ElevenLabs account; AI drafting uses its connected AI provider. Provider usage is billed to the connected accounts. Review inferred steps before sharing.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.generate_guide \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_generate_guide at https://app.chirply.io/api/mcp, same bearer token, same input.

Send the saved transcript, brand voice and bounded business knowledge to the connected AI provider to draft sales copy, deliverables and proposed money terms. Provider usage is billed. Creates an unpublished funnel draft; no Stripe product, checkout or customer message yet.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.generate_offer \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "request_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_generate_offer at https://app.chirply.io/api/mcp, same bearer token, same input.

Read one account recording and its editable guide, transcript and sharing settings. Does not publish content or send messages.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.get \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_get at https://app.chirply.io/api/mcp, same bearer token, same input.

Read an ordered playlist of recordings the caller can access within this account. Unavailable items are omitted; no messages are sent.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.get_collection \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_get_collection at https://app.chirply.io/api/mcp, same bearer token, same input.

Read the account's saved default share hostname and eligible connected app domains, including inherited parent-agency domains. Does not publish recordings or change DNS.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.get_default_share_domain \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Over MCP the same operation is the tool capture_get_default_share_domain at https://app.chirply.io/api/mcp, same bearer token, same input.

Read an accessible render job's status, output recording and persistent error. Does not start another encode or consume additional output storage.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.get_render \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_get_render at https://app.chirply.io/api/mcp, same bearer token, same input.

Read a recording's saved share hostname override, effective hostname and eligible connected domains. Requires existing recording access; does not publish content or change DNS.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.get_share_domain \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_get_share_domain at https://app.chirply.io/api/mcp, same bearer token, same input.

Read recording password protection, public download policy and the current share URL. Returns no password or hash; only the creator or account managers can change these settings.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.get_share_security \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_get_share_security at https://app.chirply.io/api/mcp, same bearer token, same input.

List the account's private Capture video and walkthrough library, including archived recordings. Returns metadata only; no messages are sent.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.list \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 50,
    "cursor": "example"
  }'

Over MCP the same operation is the tool capture_list at https://app.chirply.io/api/mcp, same bearer token, same input.

Read accessible personal and account video collections. Collection access does not grant access to its recordings; no content is published or sent.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.list_collections \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "offset": 0,
    "limit": 50
  }'

Over MCP the same operation is the tool capture_list_collections at https://app.chirply.io/api/mcp, same bearer token, same input.

Read timestamped recording comments and replies within the caller's account access. Includes pending and hidden comments for moderation; guest names are unverified. No messages are sent.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.list_comments \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_list_comments at https://app.chirply.io/api/mcp, same bearer token, same input.

List up to100 active browsers of each connection kind in this account. Distinguishes Capture-only credentials from Browser Agent credentials; returns prefixes, never usable tokens. No recordings or permissions are changed.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.list_devices \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Over MCP the same operation is the tool capture_list_devices at https://app.chirply.io/api/mcp, same bearer token, same input.

List this account's Capture-only custom domains and DNS verification status. No changes or charges occur.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.list_domains \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Over MCP the same operation is the tool capture_list_domains at https://app.chirply.io/api/mcp, same bearer token, same input.

Read sales offer drafts created from this recording. Account managers only; no provider usage or messages.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.list_offers \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_list_offers at https://app.chirply.io/api/mcp, same bearer token, same input.

Read a bounded page of accessible recording renders in this account. Personal output access is enforced; private source snapshots and provider URLs are never returned.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.list_renders \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 20,
    "before": "example"
  }'

Over MCP the same operation is the tool capture_list_renders at https://app.chirply.io/api/mcp, same bearer token, same input.

List up to 100 saved metadata versions of a recording the caller can access. Personal recordings require their identified creator; version history is never public. No messages are sent.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.list_versions \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_list_versions at https://app.chirply.io/api/mcp, same bearer token, same input.

Read the signed-in member's saved recordings. A userless trusted account API manager must specify target_user_id; paired devices cannot use another member's list. Existing recording access still applies.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.list_watch_later \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "offset": 0,
    "limit": 50
  }'

Over MCP the same operation is the tool capture_list_watch_later at https://app.chirply.io/api/mcp, same bearer token, same input.

Merge two adjacent guide steps and retain the explicitly selected screenshot. Saves the changed guide immediately, including on existing share links. No messages are sent.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.merge_steps \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "index": 1,
    "keep_screenshot": "first"
  }'

Over MCP the same operation is the tool capture_merge_steps at https://app.chirply.io/api/mcp, same bearer token, same input.

Approve or hide a comment from public viewers, or resolve its discussion. Restricted to the creator and signed-in account managers. Approval exposes the comment to existing share-link viewers; no new message is sent.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.moderate_comment \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "comment_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_moderate_comment at https://app.chirply.io/api/mcp, same bearer token, same input.

Read recording comment moderation and owner notification preferences for in-app, email and push channels. Does not send messages or change device permissions.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.notification_preferences \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_notification_preferences at https://app.chirply.io/api/mcp, same bearer token, same input.

Plan retained clips from selected whole saved caption blocks and return their total duration for review. Does not encode, save a render draft, publish, or spend provider money. This is block timing, not word precision; use the reviewed clips with Create rendered video to encode later.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.plan_keep_transcript_blocks \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "selected_indices": [
      1
    ]
  }'

Over MCP the same operation is the tool capture_plan_keep_transcript_blocks at https://app.chirply.io/api/mcp, same bearer token, same input.

Plan a video cut that removes selected whole saved caption blocks while retaining unselected footage and unscripted gaps. Returns clips and duration for review; does not encode, save, publish, or spend provider money. No word-level precision is claimed; overlapping caption boundaries are rejected.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.plan_remove_transcript_blocks \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "selected_indices": [
      1
    ]
  }'

Over MCP the same operation is the tool capture_plan_remove_transcript_blocks at https://app.chirply.io/api/mcp, same bearer token, same input.

Read whether the saved recording draft differs from its immutable published version and whether its current share grant is active. Does not publish changes or alter access.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.publication_status \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_publication_status at https://app.chirply.io/api/mcp, same bearer token, same input.

Publish the saved recording draft as an immutable version. Existing share links immediately show the new title, guide, screenshots and captions permitted by their current audience. Does not create a share link or change its access or expiration.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.publish_changes \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_publish_changes at https://app.chirply.io/api/mcp, same bearer token, same input.

Add a like, celebration or question reaction to a visible comment. Public readers see aggregate counts; no email or push notification is sent.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.react_comment \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "reaction": "like",
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "comment_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_react_comment at https://app.chirply.io/api/mcp, same bearer token, same input.

Mark one in-app recording notification read for its signed-in recipient. Cannot mark another person's notification; no messages are sent.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.read_notification \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_read_notification at https://app.chirply.io/api/mcp, same bearer token, same input.

Send selected saved guide steps and rewrite directions to the connected OpenRouter model, billed to the account. Returns reviewed text patches only; unselected content, screenshots, URLs and timing are preserved. Per-token price ceilings and an 8000-token output limit apply. No draft is saved or published, and failed or uncertain request IDs never trigger an automatic paid retry.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.regenerate_selected_steps \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "request_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "expected_updated_at": "2026-09-17T15:00:00Z",
    "model": "example",
    "operation": "regenerate",
    "locale": "en",
    "step_ids": [
      "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
    ],
    "caption_indices": [
      1
    ],
    "max_prompt_per_million": 1,
    "max_completion_per_million": 1,
    "confirm_provider_transfer": true,
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_regenerate_selected_steps at https://app.chirply.io/api/mcp, same bearer token, same input.

Remove the acting user's or account integration's own reaction from a comment. Public aggregate counts change; no messages are sent.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.remove_comment_reaction \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "reaction": "like",
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "comment_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_remove_comment_reaction at https://app.chirply.io/api/mcp, same bearer token, same input.

Remove the recording's password so anyone holding the current share URL can view its published content. Revokes existing viewer tickets, preserves the download policy and sends no messages. Only the creator or account managers can change protection.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.remove_share_password \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_remove_share_password at https://app.chirply.io/api/mcp, same bearer token, same input.

Remove a member's recording bookmark without deleting its video. Does not publish or send anything; only the signed-in member or a userless trusted API manager with target_user_id can select the list.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.remove_watch_later \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "project_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_remove_watch_later at https://app.chirply.io/api/mcp, same bearer token, same input.

Replace saved draft title, description, guide steps, screenshots, transcript, captions and thumbnail with the currently published version. Discards saved draft edits; leaves source media, ownership, access, share links and expiration unchanged.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.restore_published_draft \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_restore_published_draft at https://app.chirply.io/api/mcp, same bearer token, same input.

Restore saved guide, transcript, captions and descriptive metadata, first saving the current version. Existing public viewers see the restored content. Sharing tokens, expiration, privacy, ownership and original video are never restored or changed.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.restore_version \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "version_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_restore_version at https://app.chirply.io/api/mcp, same bearer token, same input.

Immediately revoke the selected browser token. Capture-only revocation affects Capture; choosing browser_agent disables Capture and all Browser Agent tasks using that connection. Its next request fails authentication. Saved recordings remain available; no notifications are sent.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.revoke_device \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_revoke_device at https://app.chirply.io/api/mcp, same bearer token, same input.

Disable a recording's current unlisted link immediately. Anyone who already downloaded the video retains their copy. No messages are sent.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.revoke_share \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_revoke_share at https://app.chirply.io/api/mcp, same bearer token, same input.

Save edited screenshot pixels as a new immutable private image revision. Preserves original bytes and the currently published image until Publish changes. Consumes storage; stale edits cannot overwrite newer changes. No messages are sent.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.save_image_edit \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "revision_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "expected_updated_at": "2026-09-17T15:00:00Z",
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "mime_type": "image/png",
    "base64": "example"
  }'

Over MCP the same operation is the tool capture_save_image_edit at https://app.chirply.io/api/mcp, same bearer token, same input.

Replace the recording's ordered written guide, removing omitted steps. An existing shared guide immediately shows the saved version. No messages are sent.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.save_steps \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "steps": [
      {
        "title": "Example"
      }
    ],
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_save_steps at https://app.chirply.io/api/mcp, same bearer token, same input.

Save an immutable snapshot of the recording's current guide, captions, transcript and descriptive metadata. Original video, ownership and sharing credentials are not copied or changed. No messages are sent.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.save_version \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_save_version at https://app.chirply.io/api/mcp, same bearer token, same input.

Bookmark an accessible recording for a current account member. Does not publish content or send messages; a userless trusted API manager must specify target_user_id.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.save_watch_later \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "project_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_save_watch_later at https://app.chirply.io/api/mcp, same bearer token, same input.

Replace the ordered recording list in a collection, removing omitted entries without deleting source recordings. Account viewers see changes immediately; no messages are sent.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.set_collection_items \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "project_ids": [
      "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
    ],
    "revision": 1,
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_set_collection_items at https://app.chirply.io/api/mcp, same bearer token, same input.

Save the default hostname used when copying video and screenshot share links for this account. Existing tokens and privacy remain unchanged, and old links remain valid. Only account managers can change this; no DNS changes, messages or charges occur.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.set_default_share_domain \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "example"
  }'

Over MCP the same operation is the tool capture_set_default_share_domain at https://app.chirply.io/api/mcp, same bearer token, same input.

Change whether public viewers can use the recording's original video download control and endpoint. May rotate the share URL and revokes access tickets. Playback remains available to authorized viewers, who can still capture delivered content; this is not DRM. Sends no messages and incurs no provider charge.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.set_download_policy \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "allow_download": true
  }'

Over MCP the same operation is the tool capture_set_download_policy at https://app.chirply.io/api/mcp, same bearer token, same input.

Set comment visibility and owner alerts for new viewers and comments. Enabling email or push allows future real notifications and email provider charges; existing device permission remains required. Only the creator or signed-in account managers may change these preferences.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.set_notification_preferences \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "comments_enabled": true,
    "moderate_comments": true,
    "notify_views": true,
    "notify_comments": true,
    "in_app": true,
    "email": true,
    "push": true,
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_set_notification_preferences at https://app.chirply.io/api/mcp, same bearer token, same input.

Save a hostname override for one video or screenshot, or null to use the account default. Only its creator or account managers can change it. Preserves the share token, password and old links; does not publish private content, change DNS, send messages or incur charges.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.set_share_domain \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "example",
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_set_share_domain at https://app.chirply.io/api/mcp, same bearer token, same input.

Set or replace a recording share password, stored by Capture only as a bcrypt hash. Revokes current viewer tickets and may rotate the share URL; copy the returned current URL. API/MCP clients must protect their own request logs. No messages are sent or provider charges incurred. Use the owner Share security form instead of entering secrets in Copilot chat.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.set_share_password \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "password": "example"
  }'

Over MCP the same operation is the tool capture_set_share_password at https://app.chirply.io/api/mcp, same bearer token, same input.

Store a new immutable JPEG thumbnail for the recording. Existing video share viewers see this thumbnail; guide-only shares do not expose it. This consumes storage and sends no messages.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.set_thumbnail \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "base64": "example"
  }'

Over MCP the same operation is the tool capture_set_thumbnail at https://app.chirply.io/api/mcp, same bearer token, same input.

Publish the selected video, written guide or both through an unlisted link accessible to anyone holding it. This exposes recording content outside the account; it does not email the link.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.share \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "audience": "video",
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_share at https://app.chirply.io/api/mcp, same bearer token, same input.

Split a guide instruction at a text offset into two adjacent steps. The original keeps its screenshot; the new step contains text only. Saves immediately to the guide and existing share links, without sending messages.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.split_step \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "index": 1,
    "offset": 1
  }'

Over MCP the same operation is the tool capture_split_step at https://app.chirply.io/api/mcp, same bearer token, same input.

Start or resume an 8 MiB multipart video upload into private account storage, up to 10 GiB. Returns the upload session and completed parts; uploading consumes existing storage capacity and sends no messages.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.start_upload \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "mime_type": "video/webm",
    "size_bytes": 1,
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_start_upload at https://app.chirply.io/api/mcp, same bearer token, same input.

Read stored recording bytes, in-flight reserved bytes and the account's configured Capture storage cap. A null cap means none is configured, not an unlimited plan entitlement. No messages are sent.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.storage \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Over MCP the same operation is the tool capture_storage at https://app.chirply.io/api/mcp, same bearer token, same input.

Read the account's connected text model, current catalog per-token prices and selection limits for Capture translation and rewriting. No recording content is sent to AI, no generation runs and no provider charge is incurred.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.text_ai_preflight \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_text_ai_preflight at https://app.chirply.io/api/mcp, same bearer token, same input.

Send the private recording to the selected account-connected speech provider and replace its saved transcript and captions with provider-timed results. ElevenLabs uses scribe_v2 for videos under 2 GiB; OpenRouter uses the selected Whisper model for WebM/MP4 files up to 16 MiB. Usage is billed to the connected provider account. No automatic retries, messages or publishing; failures may still incur provider charges.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.transcribe \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_transcribe at https://app.chirply.io/api/mcp, same bearer token, same input.

Read connected speech providers, available Capture transcription models and file limits for this recording. Does not send recording data to a provider or incur generation charges.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.transcription_options \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_transcription_options at https://app.chirply.io/api/mcp, same bearer token, same input.

Send explicitly selected saved guide and caption text to the connected OpenRouter model for translation. The provider bills the account; reviewed per-million price ceilings and an 8000-token output limit apply, not a guaranteed final invoice cap. Returns a draft only, preserving IDs, screenshots and timing. Reuse the same request UUID to check its receipt; failed or uncertain requests never retry automatically.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.translate_selected_content \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "request_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "expected_updated_at": "2026-09-17T15:00:00Z",
    "model": "example",
    "operation": "translate",
    "locale": "en",
    "step_ids": [
      "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
    ],
    "caption_indices": [
      1
    ],
    "max_prompt_per_million": 1,
    "max_completion_per_million": 1,
    "confirm_provider_transfer": true,
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_translate_selected_content at https://app.chirply.io/api/mcp, same bearer token, same input.

Stop future reply notifications for the acting account member, or an explicit target member managed by an API credential. Messages already delivered cannot be recalled; no new messages are sent.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.unfollow_thread \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "comment_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_unfollow_thread at https://app.chirply.io/api/mcp, same bearer token, same input.

Change a recording's title, description, transcript or archive state. Existing share links show these changes immediately; this does not send messages.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.update \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_update at https://app.chirply.io/api/mcp, same bearer token, same input.

Change a video collection's title, description or account visibility. Existing account links reflect the change immediately; no messages are sent.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.update_collection \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "revision": 1,
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_update_collection at https://app.chirply.io/api/mcp, same bearer token, same input.

Store a private standalone raster screenshot in a Capture project created with mode screenshot. Validates image format and dimensions and consumes account storage. Does not publish or send notifications; original bytes are immutable.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.upload_image \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "mime_type": "image/png",
    "base64": "example"
  }'

Over MCP the same operation is the tool capture_upload_image at https://app.chirply.io/api/mcp, same bearer token, same input.

Upload one base64-encoded video part to an existing private recording upload. Parts are 8 MiB except the last; this consumes account storage without publishing or sending messages.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.upload_part \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "part_number": 1,
    "base64": "example"
  }'

Over MCP the same operation is the tool capture_upload_part at https://app.chirply.io/api/mcp, same bearer token, same input.

Upload a JPEG image for one opted-in walkthrough step. The screenshot stays private until its guide is shared, and may contain screen content; no messages are sent.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.upload_screenshot \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "step_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "base64": "example"
  }'

Over MCP the same operation is the tool capture_upload_screenshot at https://app.chirply.io/api/mcp, same bearer token, same input.

Check DNS and TLS readiness for a Capture-only hostname and persist its current status. Does not change DNS records, send messages or incur charges.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.verify_domain \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_verify_domain at https://app.chirply.io/api/mcp, same bearer token, same input.

List connected Facebook profiles, Pages and YouTube channels available for publishing finished Capture videos. Returns names and identifiers without provider credentials.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.video_destinations \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Over MCP the same operation is the tool capture_video_destinations at https://app.chirply.io/api/mcp, same bearer token, same input.

Resume a failed video upload using its saved provider session or receipt. This continues the previously approved external publication. Uncertain Facebook submissions require checking Facebook before creating another upload.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.video_publication_resume \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_video_publication_resume at https://app.chirply.io/api/mcp, same bearer token, same input.

Read durable upload progress, platform processing status, errors and published video links for one accessible recording. Does not create another upload.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.video_publications \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "project_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_video_publications at https://app.chirply.io/api/mcp, same bearer token, same input.

Queue the actual saved video for upload to a connected Facebook profile, Page or YouTube channel with the selected visibility. Public uploads expose video outside the account. Facebook WebM preparation creates a 720p MP4 for videos up to one hour, including saved captions/annotations and reserving up to 512 MiB of recording storage. Provider limits and YouTube audit restrictions apply; stable request IDs prevent duplicate submissions.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.video_publish \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "request_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "project_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "platform": "facebook",
    "destination_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "title": "Example",
    "privacy": "private"
  }'

Over MCP the same operation is the tool capture_video_publish at https://app.chirply.io/api/mcp, same bearer token, same input.

Read the connected vision model, image support, current published token rates and screenshot limits before drafting a guide. Does not send screenshots or charge for generation.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.visual_guide_preflight \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_visual_guide_preflight at https://app.chirply.io/api/mcp, same bearer token, same input.

Open the browser consent flow for connecting a YouTube channel. A person must sign in to Google and approve video access; this capability itself stores no tokens and publishes no video.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.youtube_connect \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Over MCP the same operation is the tool capture_youtube_connect at https://app.chirply.io/api/mcp, same bearer token, same input.

Delete this account’s stored YouTube refresh token. Future publishing to this connection stops; videos already uploaded to YouTube remain available there.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/capture.youtube_disconnect \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool capture_youtube_disconnect at https://app.chirply.io/api/mcp, same bearer token, same input.