Direct Upload
Request Body required
Section titled “Request Body required ”The main request model for uploading a file, containing the blob details.
object
An object containing all necessary metadata about the file blob.
object
The original name of the file being uploaded.
The MIME type of the file (e.g., ‘image/png’ or ‘application/pdf’).
The size of the file in bytes.
A cryptographic checksum (e.g., Base64 encoded SHA-256 hash) for data integrity verification.
Responses
Section titled “ Responses ”Successful Response
The complete response model for a successful file record creation or lookup.
object
The unique database ID of the file record.
The unique key used by the storage service (e.g., S3 key or Active Storage key).
The original name of the file.
The MIME type of the file.
An object containing additional, service-specific metadata (currently empty).
object
The name of the storage service used (e.g., ‘amazon’).
The size of the file in bytes.
The content hash (e.g., Base64 SHA-256) for data integrity.
Timestamp when the file record was created.
A globally unique, signed identifier for the file record.
Details for a direct upload, typically containing a pre-signed URL and necessary headers.
object
The pre-signed URL to upload the file directly to the storage service (e.g., AWS S3).
A dictionary of required headers for the PUT request to the upload URL.
object
The MIME type of the content (e.g., image/png).
The Base64 encoded MD5 hash of the file content for integrity check.
Suggested filename for saving the content.
Direct upload or common resource creation failed upstream
Not Found
Validation Error
object
object
Internal Server Error