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-project-share.md, and every docs URL returns Markdown when requested with Accept: text/markdown.

Get a project's share
Returns the currently published project_share for a project.
GET https:/
- Key scope:
projects:read - Auth header:
Authorization: Bearer <apiKey> - Body: None
Request
Pass project_id in the path; takes no request body.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
#project_id | string | Required: Yes | Unique identifier of the project. |
Headers
| Field | Type | Required | Description |
|---|---|---|---|
#Diffio-End-User | string | Required: No | Optional end-user identifier (up to 128 characters). Scopes the request to that end user's projects; omit to act across the whole account. |
Request
import os
from diffio import DiffioClient
key = os.environ["DIFFIO_API_KEY"]
client = DiffioClient(api_key=key)
share = client.shares.get(
"62f62565-049f-5e7e-bbd2-9de0cf7ddbfe",
)Response
Returns the active project_share.
Success: 200OK.
Response fields
| Field | Type | Present | Description |
|---|---|---|---|
#object | string | Always | Resource type, always "project_share".project_share |
#id | string | Always | Public 17-character share identifier passed to GET /shares/{share_id}. |
#generation_id | string | null | Always | Identifier of the shared generation, or null until the project has a finished generation. |
#files | object | Always | Map of shared playback artifact names to signed media URLs (never includes original); {} until a generation finishes. |
#base_url | string | null | Always | URL prefix shared by every entry in files (plays hls_master in standard HLS players), or null until a generation finishes. |
Other response fields7 fields
| Field | Type | Present | Description |
|---|---|---|---|
#project_id | string | Always | Identifier of the shared project. |
#file_name | string | null | Always | Recording filename on the project, or null. |
#content_type | string | null | Always | Recording MIME type, or null. |
#created_at | string | null | Always | ISO 8601 UTC timestamp when the share was first published, or null. |
#has_video | boolean | Always | True when the project contains video. |
#duration_seconds | number | null | Always | Duration of the shared recording in seconds, or null. |
#preview_seconds | integer | null | Always | Playback 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 project's published share.400Bad request.Diffio-End-Userexceeds 128 characters.invalid_header403Forbidden: the key lacks permission.Key is inactive or lacksprojects:read.permission_denied404Not found.Project not found, or the project has no active published share.project_not_foundshare_not_found401Unauthorized: the API key is missing or invalid.405Client error.Same on every endpoint401Unauthorized: the API key is missing or invalid. Missing API key (code missing_api_key), or invalid API key (code invalid_api_key).405Client error. HTTP method not supported on this path; check the Allow header (code method_not_allowed).
Example error response
Errors are JSON: an error object with code, message and request_id. An unrecognized key returns 401Unauthorized: the API key is missing or invalid.:
Error response
{
"error": {
"code": "invalid_api_key",
"message": "Invalid API key.",
"request_id": "dead773b60e148fd9e22d680a22fa701"
}
}Notes
- To read a share from a browser or public client without an API key, pass the share's
idto Get a share instead. - A project's
share_idfield on Get a project also shows whether a share is currently published.