Share a Sume Format with a partner using its docs call sheet URL

Every Format with a handle and slug has a call sheet at docs.sume.com/formats/{handle}/{slug}: curl, scopes and polling, without the Format body.

4 min readSume
All posts

To tell a partner how to call one of your Formats, send them its call sheet: https://docs.sume.com/formats/{handle}/{slug}. Sume's docs describe it as a share link with the curl, scopes and poll loop for that Format and nothing from its body, so passing it on reveals how to call the Format but not how it is written.

What it contains

The docs say the page carries the scopes, curl, spend cap, poll and cancel sections, addressed to that Format. The pages are handoff links rather than navigation, so they do not appear in the sidebar. They render for any well-formed address and never show the Format's body.

Facts from docs.sume.com/formats/catalog and /formats, checked 2026-10-01
ItemValue
URLhttps://docs.sume.com/formats/{handle}/{slug}
IncludesScopes, curl, spend cap, poll, cancel
Does not includeThe Format body
Catalog handlesume (ready-made Formats by Sume)
Scopes the caller needsformats:read, formats:write

Handoff checklist

The call sheet shows how to call; it does not give access. A partner still needs their own API key with the right scopes. For a team Format they need a key from that team's workspace, because a personal key is refused with 403 workspace_key_required. To let another workspace call yours with its own key, the owner can share the Format with that workspace by adding its team handle on the Format's Access tab; the run, spend and media then belong to the caller's workspace.

Before you send the link, check the Format's API tab: the owner can set it Inactive or turn the API call trigger off, and either one returns a 409 to every caller.

  • Send the call sheet URL, not the Format body.
  • Tell them to persist invoke_url (the skl_ path), which survives renames.
  • Agree an Idempotency-Key convention so retries do not double-bill.

Limits

The page is public to anyone holding the address, so treat the handle and slug as non-secret and keep any customer data in the request. A renamed handle keeps resolving for 90 days, after which an old call sheet address stops matching. The call sheet is documentation, not a sandbox: calling the Format spends real money from the caller's wallet, bounded by the spend cap.

Related posts

More in Formats

All Formats posts

Written by Sume