Read the public share URL of a file
A READ. It returns the URL of an already-public file; it does not publish anything. Make the file public first with PUT /v1/files/{uuid}/visibility, or this answers 409.
The returned URL is PERMANENT, UNAUTHENTICATED and has NO EXPIRY. It is not a signed link and it carries no token. Anyone who receives it - forwarded, scraped, logged, pasted into a chat - can fetch the file, with no credentials, indefinitely. Handing this URL to anyone is publishing the file.
Do not confuse it with the presigned URL that GET /v1/files/{uuid}/download returns. Those two look superficially similar and are opposites: one expires in an hour, this one never does.
Setting the file private again removes the public file page but does NOT retroactively unpublish bytes already fetched or cached, and does not stop the legacy serve and thumbnail routes. The same three facts are returned as DATA below - is_permanent, requires_authentication, expires_at - so a caller that never reads prose still gets them.
The share-count beacon that the web app posts is deliberately NOT exposed on this API: it is unauthenticated product analytics and exposing it would hand a token holder a counter to inflate.
Request
- Base URL: https://contentmaschine.ai/api
- URL: https://contentmaschine.ai/api/v1/files/{uuid}/share
- Auth: one of:
- HTTP bearer
- OAuth 2 (authorization code, authorization URL https://contentmaschine.ai/api/oauth/authorize, token URL https://contentmaschine.ai/api/oauth/token)
Path parameters
The file uuid of an item in your library (from the gallery or library list, or a finished job).
Response
The share URL, with its properties stated as data.
Example response
{
"success": true
}Changes
No recorded changes to this operation across all 1 revision of this API.