Skip to content

Retrieve a media

View as Markdown
get /rest/api/medias/{id}

Retrieves a Media resource.

Returns a single media by id, including its contentUrl, mimeType, type, hash and image dimensions.

Headers

NameTypeRequiredDescription
X-Flowkiwi-Organization-IdstringrequiredThe organization the request acts as. Determines the identity, permissions and ownership applied when reading or modifying data on the instance.

Path parameters

NameTypeRequiredDescription
idstringrequiredMedia identifier

Response

200 - Media resource

Content-Type: application/ld+json

PropertyTypeRequiredDescription
@contextobject-
@idstringrequired
@typestringrequired
idstring-The resource's unique identifier (UUID).
contentUrlstring | null-The URL to fetch the uploaded file.
mimeTypestring | null-MIME type of the file
type"image" | "video" | "file"-Media type based on MIME type (image, video, or file)
hashstring | null-SHA256 hash of the file
dimensionsEmbeddedImageDimensionResource | null-
Show dimensions fields
PropertyTypeRequiredDescription
widthintegerrequiredImage width in pixels
heightintegerrequiredImage height in pixels
createdAtstring | null-
updatedAtstring | null-

Errors

403 - Access denied. The caller is missing one or more identity permissions required for this operation.

Content-Type: application/problem+json

PropertyTypeRequiredDescription
@contextobject-
@idstringrequired
@typestringrequired
typestring-
titlestring-
statusinteger-
detailstring-
missingPermissionsstring[]-Identity permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied identity:* permission.

404 - Not found

PropertyTypeRequiredDescription
@contextobject-
@idstringrequired
@typestringrequired
titlestring | null-A short, human-readable summary of the problem.
detailstring | null-A human-readable explanation specific to this occurrence of the problem.
statusnumber | null-
instancestring | null-A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
typestring-A URI reference that identifies the problem type