Skip to content

For AI agents: every API docs page in one plain-text file is at /docs/llms-full.txt, and the documentation index is at /llms.txt. This page is available as Markdown at https://diffio.ai/docs/api-reference/get-share.md, and every docs URL returns Markdown when requested with Accept: text/markdown.

Get a share

Public endpoint (no API key required) that returns a published share's metadata and signed playback URLs (files and base_url) for anyone holding share_id.

GET https://api.diffio.ai/v2/shares/{share_id}

  • Key scope: None (public)
  • Auth header: No API key needed
  • Body: None

Request

Pass share_id in the path; send no Authorization header or body.

Path parameters

FieldTypeRequiredDescription
#share_idstringRequired: YesPublic 17-character share identifier (id of a published share).

Request

from diffio import DiffioClient

# A public call: no API key needed.
client = DiffioClient()

share = client.shares.get_public(
    "Hq7cTnWm3RkZpY2vB",
)

Response

Returns the project_share with signed playback URLs.

Success: 200OK.

Response fields

FieldTypePresentDescription
#objectstringAlwaysResource type, always "project_share".project_share
#idstringAlwaysPublic 17-character share identifier passed to GET /shares/{share_id}.
#generation_idstring | nullAlwaysIdentifier of the shared generation, or null until the project has a finished generation.
#filesobjectAlwaysMap of shared playback artifact names to signed media URLs (never includes original); {} until a generation finishes.
#base_urlstring | nullAlwaysURL prefix shared by every entry in files (plays hls_master in standard HLS players), or null until a generation finishes.
Other response fields7 fields
FieldTypePresentDescription
#project_idstringAlwaysIdentifier of the shared project.
#file_namestring | nullAlwaysRecording filename on the project, or null.
#content_typestring | nullAlwaysRecording MIME type, or null.
#created_atstring | nullAlwaysISO 8601 UTC timestamp when the share was first published, or null.
#has_videobooleanAlwaysTrue when the project contains video.
#duration_secondsnumber | nullAlwaysDuration of the shared recording in seconds, or null.
#preview_secondsinteger | nullAlwaysPlayback cap in seconds (rounded up to whole 4-second segments), or null when the full recording is shared.

Response 200OK.

Response: key fields
{
  "object": "project_share",
  "id": "Hq7cTnWm3RkZpY2vB",
  "generation_id": "ce832a32-a1ce-516a-b8bd-75457bd8517f",
  "base_url": "https://media.diffio.io/s/v1.REDACTED/",
  "files": {
    "audio": "https://media.diffio.io/s/v1.REDACTED/generations/ce832a32-a1ce-516a-b8bd-75457bd8517f/restored.mp3",
    "audio_mixed": "https://media.diffio.io/s/v1.REDACTED/generations/ce832a32-a1ce-516a-b8bd-75457bd8517f/mixed.mp3",
    "hls_master": "https://media.diffio.io/s/v1.REDACTED/generations/ce832a32-a1ce-516a-b8bd-75457bd8517f/hls/master.m3u8",
    "hls_original": "https://media.diffio.io/s/v1.REDACTED/generations/ce832a32-a1ce-516a-b8bd-75457bd8517f/hls/noisy/index.m3u8",
    "hls_restored": "https://media.diffio.io/s/v1.REDACTED/generations/ce832a32-a1ce-516a-b8bd-75457bd8517f/hls/clean/index.m3u8",
    "metadata": "https://media.diffio.io/s/v1.REDACTED/generations/ce832a32-a1ce-516a-b8bd-75457bd8517f/metadata.json",
    "stems_manifest": "https://media.diffio.io/s/v1.REDACTED/generations/ce832a32-a1ce-516a-b8bd-75457bd8517f/stems/4014a8c299444bbb866971bbb7b657ca/manifest.v2.json",
    "transcript": "https://media.diffio.io/s/v1.REDACTED/generations/ce832a32-a1ce-516a-b8bd-75457bd8517f/word_timestamps.json",
    "waveform_original": "https://media.diffio.io/s/v1.REDACTED/generations/ce832a32-a1ce-516a-b8bd-75457bd8517f/visualizations/hls_waveform_noisy.json",
    "waveform_restored": "https://media.diffio.io/s/v1.REDACTED/generations/ce832a32-a1ce-516a-b8bd-75457bd8517f/visualizations/hls_waveform_clean.json"
  }
}

Return codes

  • 200OK.Returns the public share and its playback URLs.
  • 404Not found.No active share matches share_id, or the share was revoked. share_not_found
  • 405Client error.Same on every endpoint
    • 405Client error. HTTP method not supported on this path; check the Allow header (code method_not_allowed).

Example error response

Error response
{
  "error": {
    "code": "share_not_found",
    "message": "No share has that id, or it is no longer shared.",
    "request_id": "6e0f0641ec4f4c4eb6b1a5ce51ec6ac0"
  }
}

Notes

  • Allows cross-origin browser requests (Access-Control-Allow-Origin: *), and files.hls_master plays audio and video directly in standard HLS players.
  • Never exposes the uploaded original file or the project's other generations.
  • Re-fetch GET /shares/{share_id} whenever a listener opens the share so the player always receives current URLs.

Report an issue with this page