Create or update the Hive shared link for one report. A public link can be opened by anyone who has it, so your AI asks you before this runs; with Hive approvals on, Hive asks again inside Hive.

This reaches real people, so the person is asked before it runs. Their own AI client asks them. When the connection was made with Hive approvals switched on, the first call returns a single-use Hive approval link instead of acting, and the exact request is repeated with approvalToken and an Idempotency-Key once they approve it inside Hive.

post/api/v1/tools/share_report

Request

  • Base URL: https://hivepublish.com
  • URL: https://hivepublish.com/api/v1/tools/share_report
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Required on the approved retry; optional while requesting the initial approval challenge.

Request body

reportIdstring required

The Hive report id.

visibility'invite_only' | 'public' required

invite_only sends it to named addresses; public can be opened by anyone with the link.

titlestring required

The title people see on the shared page.

descriptionstring
recipientsstring[]

Email addresses invited to an invite-only link.

expiresAtstring

Optional ISO expiry, within the next year.

dynamicDateboolean

true keeps the report’s date period live; false freezes today’s range into the link.

rotateboolean

true issues a new link and retires the old one.

approvalTokenstring

Single-use token returned by Hive after the owner approves this exact action.

Response

Tool result or approval challenge

OR

Changes

No recorded changes to this operation across all 1 revision of this API.