Beecargo

Get set up

  • ○Sign in
  • ○Connect your agent
  • ○Share a file

API

OverviewUpload a fileRemote uploadShare settingsClaim a fileAgent APIWebhooksRetrieve a fileGet file infoList files & foldersDelete a file

MCP

OverviewRegister an agentUpload a fileUpload statusRemote uploadLarge uploads & jobsFoldersShare settingsSeller payoutsBuy a priced shareClaim fileSearch toolsCreate checkoutRetrieve a fileGet file infoList filesDelete a fileFiles from a runUpload delegation
PreviousFoldersNextSeller payouts
BlogPricingDashboardPrivacyTerms

Update share settings

Change visibility, one-time price, direct download, public retention, and optional unlock protection on a file or growable Shipment you own.

Same flow over HTTP: PATCH /files/share-settings

Tool

beecargo_update_share_settings

Use after upload, or when someone upgrades to Pro and wants forever retention or a new TTL. Set priceCents for a paid share (seller Connect must be ready). Set protect to create unlock credentials. For growable Shipments from openShare, pass shortId (or the member fileId). Maps to PATCH /files/share-settings.

Authentication

API key required. The file or Shipment must be owned and claimed (not anonymous).

Parameters

ParameterTypeRequiredDescription
fileIdStringNoFile id from the upload response (required if shortId is omitted)
shortIdStringNoShare shortId — one-file share or growable Shipment from openShare (required if fileId is omitted)
visibilityunlisted | publicNoPublic needs a claimed username on the account
priceCentsInteger | nullNoOne-time price in the smallest currency unit (minimum 100). Pass 0 or null to clear. Positive prices require seller Connect readyToSell. Pair with currency (default usd).
currencyusd | eur | aed | brl | jpy | krw | cny | rubNoCharge currency for priceCents. Defaults to usd. JPY and KRW use whole units (no cents).
directBooleanNoPro only: auto-start download when the /d link opens
retentionttl | foreverNoPublic + Pro only for forever
expiresAtString (ISO)NoExpiry when retention is ttl
extendTtlStringNoAdd more keep time from now (for example 7d) without picking an exact expiry date
protectBooleanNoWhen true, create a download unlock code and delivery link (returned once). When false, clear protection.
handoffMessageStringNoOptional note (max 480 chars) shown on the delivery link /h/{token}
immutableBooleanNoWhen true, the file cannot be casually changed or deleted
upstreamFileIdsString[]NoOptional parent file ids for pipeline lineage

Usage notes

  • Pass at least one of fileId or shortId.
  • Before a positive priceCents, call beecargo_connect with action=onboard / action=status until readyToSell.
  • Buyers pay on the human share page /d/{shortId} — not through this tool.
  • Free public shares last 7 days; forever and direct need Pro.
  • While Pro is active, recipients get sponsored ad-free, wait-free downloads on your links without signing in.
  • Upgrading to Pro does not rewrite existing Free public TTLs. Call this tool with extendTtl or set forever.
  • CLI beecargo share covers the same fields (--price-cents, --protect, …). beecargo extend is the same idea as extendTtl here.
  • When protect is on, the response includes unlockCode and handoffUrl once. Share both on a private channel. The /d link alone is not enough to download.
  • Recipients can open handoffUrl (message + unlock) or type unlockCode on /d/{shortId}.
  • For a growable multi-file Shipment, protect on shortId unlocks the whole set — not each member file separately.