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.
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
string | object
-
@id
string
required
@type
string
required
contentUrl
string | null
-
The URL to fetch the uploaded file.
createdAt
string | null
-
dimensions
EmbeddedImageDimensionResource | null
-
Image dimensions (width and height in pixels). Only present for image files.
Show dimensions fields
Property
Type
Required
Description
height
integer
required
Image height in pixels
width
integer
required
Image width in pixels
hash
string | null
-
SHA256 hash of the file
id
string
-
The resource's unique identifier (UUID).
mimeType
string | null
-
MIME type of the file
type
"image" | "video" | "file"
-
Media type based on MIME type (image, video, or file)
updatedAt
string | null
-
Errors
400 - Invalid input
Property
Type
Required
Description
@context
string | object
-
@id
string
required
@type
string
required
code
string
-
Stable identifier of the error in the error code catalogue (see /api/error-codes). Present on catalogued errors only.
description
string | null
-
detail
string | null
-
A human-readable explanation specific to this occurrence of the problem.
instance
string | null
-
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
message
string
-
End-user message localized in the request locale, with this occurrence's values substituted. Present on catalogued errors only.
slug
string
-
Stable, readable key of the error in the error code catalogue. Present on catalogued errors only.
status
integer | null
-
title
string | null
-
A short, human-readable summary of the problem. For a catalogued error it repeats the slug.
type
string
-
A URI reference that identifies the problem type. For a catalogued error it is the error code resource, /api/error-codes/{code}.
Property
Type
Required
Description
code
string
-
Stable identifier of the error in the error code catalogue (see /api/error-codes). Present on catalogued errors only.
detail
string | null
-
A human-readable explanation specific to this occurrence of the problem.
instance
string | null
-
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
message
string
-
End-user message localized in the request locale, with this occurrence's values substituted. Present on catalogued errors only.
slug
string
-
Stable, readable key of the error in the error code catalogue. Present on catalogued errors only.
status
integer | null
-
title
string | null
-
A short, human-readable summary of the problem. For a catalogued error it repeats the slug.
type
string
-
A URI reference that identifies the problem type. For a catalogued error it is the error code resource, /api/error-codes/{code}.
403 - Access denied. The caller is missing one or more permissions required for this operation.
Content-Type:application/problem+json
Property
Type
Required
Description
@context
string | object
-
@id
string
required
@type
string
required
detail
string
-
missingPermissions
string[]
-
Permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied permission.
status
integer
-
title
string
-
type
string
-
422 - An error occurred
Property
Type
Required
Description
@context
string | object
-
@id
string
required
@type
string
required
description
string
-
detail
string
-
instance
string | null
-
status
integer
-
title
string | null
-
type
string
-
violations
object[]
-
Show violations fields
Property
Type
Required
Description
code
string
-
The code of the violation
hint
string
-
An extra hint to understand the violation
message
string
required
The message associated with the violation
parameters
object
-
Dynamic placeholder values for the violation message template (substitute into the code catalogue message).
payload
object
-
The serialized payload of the violation
propertyPath
string
required
The property path of the violation
slug
string
-
Stable centralized error-code slug for this violation (see /api/error-codes).
Property
Type
Required
Description
detail
string
-
instance
string | null
-
status
integer
-
title
string | null
-
type
string
-
violations
object[]
-
Show violations fields
Property
Type
Required
Description
code
string
-
The code of the violation
hint
string
-
An extra hint to understand the violation
message
string
required
The message associated with the violation
parameters
object
-
Dynamic placeholder values for the violation message template (substitute into the code catalogue message).
payload
object
-
The serialized payload of the violation
propertyPath
string
required
The property path of the violation
slug
string
-
Stable centralized error-code slug for this violation (see /api/error-codes).