Upload a media

post /rest/api/medias

Creates a Media resource.

Creates a media by uploading a file. This endpoint takes a multipart/form-data body (not JSON): send the binary in a file field. The response describes the stored media - its contentUrl, mimeType, derived type, hash and, for images, dimensions.

File size limits

Up to 5 MB for general files and 100 MB for videos. The mimeType, type and hash are derived from the uploaded file.

Headers

Name	Type	Required	Description
X-Flowkiwi-Organization-Id	string	required	The organization the request acts as. Determines the identity, permissions and ownership applied when reading or modifying data on the instance.

Request body

Property	Type	Required	Description
file	string	-	Upload file (max size: 5M for general files, 100M for videos)

Response

201 - Media resource created

Content-Type: application/ld+json

Property	Type	Required	Description
@context	object	-
@id	string	required
@type	string	required
id	string	-	The resource's unique identifier (UUID).
contentUrl	string | null	-	The URL to fetch the uploaded file.
mimeType	string | null	-	MIME type of the file
type	"image" | "video" | "file"	-	Media type based on MIME type (image, video, or file)
hash	string | null	-	SHA256 hash of the file
dimensions	EmbeddedImageDimensionResource | null	-
Show dimensions fields Property Type Required Description width integer required Image width in pixels height integer required Image height in pixels
createdAt	string | null	-
updatedAt	string | null	-

Errors

400 - Invalid input

Property	Type	Required	Description
@context	object	-
@id	string	required
@type	string	required
title	string | null	-	A short, human-readable summary of the problem.
detail	string | null	-	A human-readable explanation specific to this occurrence of the problem.
status	number | null	-
instance	string | null	-	A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
type	string	-	A URI reference that identifies the problem type

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

Content-Type: application/problem+json

Property	Type	Required	Description
@context	object	-
@id	string	required
@type	string	required
type	string	-
title	string	-
status	integer	-
detail	string	-
missingPermissions	string[]	-	Identity permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied identity:* permission.

422 - An error occurred

Property	Type	Required	Description
@context	object	-
@id	string	required
@type	string	required
status	integer	-
violations	object[]	-
Show violations fields Property Type Required Description propertyPath string required The property path of the violation message string required The message associated with the violation code string - The code of the violation hint string - An extra hint to understand the violation payload object - The serialized payload of the violation
detail	string	-
type	string	-
title	string | null	-
instance	string | null	-