Skip to main content

Data Product Share Link

Get, create, rotate, or revoke the public share link for a data product. A share token exposes a read-only public URL to the assembled dataset.

A share token exposes a read-only public link to a data product. Anyone with the link can view the assembled dataset without an API key or platform login. Use this to hand a finished dataset to a downstream consumer, an auditor, or a client who should see the output but should not have access to your workspace.

Each data product has at most one active share token at a time. The token is not created automatically: a product is private until you explicitly create a share link. The public URL has the form https://app.talonic.com/share/{token}, where {token} is an opaque, hard-to-guess string.

The lifecycle is three operations on the same /share sub-resource. GET reads the current link (or reports that none exists), POST creates a link or rotates the existing one, and DELETE revokes the link so the public URL stops working. Rotation issues a fresh token and invalidates the previous URL while keeping any password that was set on the share.

Anyone holding the share URL can read the full dataset. Rotate the link with POST /share if a URL leaks: rotation invalidates the old token immediately. Revoke with DELETE /share when the data should no longer be public.
GET/v1/data-products/{id}/share

Get Response

Response fields

shareobject | nullThe share link object, or null if no token exists for this product.
share.tokenstringOpaque share token used in the public URL.
share.urlstringFull public URL of the form https://app.talonic.com/share/{token}.
share.has_passwordbooleanWhether the share link is password-protected.
share.created_atstringISO 8601 timestamp when the current token was issued.

Response (no link yet)

{
  "share": null
}

Response (active link)

{
  "share": {
    "token": "shr_8f3a1c2e7b904d56a1e0f2c3",
    "url": "https://app.talonic.com/share/shr_8f3a1c2e7b904d56a1e0f2c3",
    "has_password": false,
    "created_at": "2024-11-02T09:15:00.000Z"
  }
}

Create or Rotate Share Link

Create the share link, or rotate it if one already exists. Both cases return the same share object shape. On first call a new token is minted; on subsequent calls a fresh token replaces the old one and the previous public URL stops resolving. Any password configured on the share is preserved across a rotation.

POST/v1/data-products/{id}/share

Response

{
  "share": {
    "token": "shr_2d7e9a4f1c0b836e5a9d4f10",
    "url": "https://app.talonic.com/share/shr_2d7e9a4f1c0b836e5a9d4f10",
    "has_password": false,
    "created_at": "2024-11-05T16:40:00.000Z"
  }
}

Revoke Share Link

Revoke the share link, disabling its public URL. The operation is idempotent: calling it when no link exists still returns successfully with revoked: false. After revocation the public URL returns a not-found page until a new link is created.

DELETE/v1/data-products/{id}/share

Revoke Response

Response fields

revokedbooleanTrue if an active link was revoked; false if there was no link to revoke.
idstringData product UUID.

Response

{
  "revoked": true,
  "id": "d1a2b3c4-e5f6-7890-abcd-ef1234567890"
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
404not_foundData product not found or does not belong to your organization.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.