Skip to main content
POST
Share a surface

Authorizations

Authorization
string
header
required

Personal Access Token. Send as Authorization: Bearer hq_pat_....

Path Parameters

id
string<uuid>
required

Surface id

Body

application/json
ttl_secs
integer<int64> | null

Seconds the signed URL stays valid for. None defaults to 7 days; clamped to the [1 min, 30 day] inclusive range. Anything outside that range is rejected so a typo in the SPA can't mint a year-long link.

Response

Time-limited signed share URL

exp
integer<int64>
required

Unix-ts seconds; the SPA renders "expires …" using this.

surface_id
string<uuid>
required
url
string
required

Tokenized URL the user copies. Valid until exp.