{ "openapi": "3.1.0", "info": { "title": "Relay API", "version": "2026-10-07", "description": "Upload, manage and share files on Relay. Human-readable docs: https://relay.xstlo.com/docs?tab=api. Errors carry a stable `code`; every response has an X-Request-Id header." }, "servers": [ { "url": "https://relay.xstlo.com" } ], "security": [ { "bearer": [] } ], "tags": [ { "name": "Upload" }, { "name": "Files" }, { "name": "Folders" }, { "name": "Account" }, { "name": "Webhooks" }, { "name": "Image hosting" } ], "paths": { "/api/files/upload": { "post": { "summary": "Upload a file (direct, under ~4MB)", "tags": [ "Upload" ], "security": [ {}, { "bearer": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "folderId": { "type": "string" } }, "required": [ "file" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "const": true }, "data": { "$ref": "#/components/schemas/UploadedFile" } }, "required": [ "success", "data" ] } } } }, "400": { "$ref": "#/components/responses/E400" }, "404": { "$ref": "#/components/responses/E404" }, "413": { "$ref": "#/components/responses/E413" }, "429": { "$ref": "#/components/responses/E429" }, "507": { "$ref": "#/components/responses/E507" } } } }, "/api/files/multipart/init": { "post": { "summary": "Start a multipart upload", "tags": [ "Upload" ], "security": [ {}, { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fileName": { "type": "string" }, "fileSize": { "type": "integer" }, "fileType": { "type": "string" }, "folderId": { "type": "string" } }, "required": [ "fileName", "fileSize" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "uploadId": { "type": "string" }, "key": { "type": "string" }, "chunkSize": { "type": "integer" }, "totalParts": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/E400" }, "404": { "$ref": "#/components/responses/E404" }, "413": { "$ref": "#/components/responses/E413" }, "429": { "$ref": "#/components/responses/E429" }, "507": { "$ref": "#/components/responses/E507" } } } }, "/api/files/multipart/batch-urls": { "post": { "summary": "Get presigned part URLs", "tags": [ "Upload" ], "security": [ {}, { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string" }, "uploadId": { "type": "string" }, "totalParts": { "type": "integer" } }, "required": [ "key", "uploadId", "totalParts" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "urls": { "type": "object", "additionalProperties": { "type": "string" } } } } } } }, "400": { "$ref": "#/components/responses/E400" } } } }, "/api/files/multipart/complete": { "post": { "summary": "Finish a multipart upload", "tags": [ "Upload" ], "security": [ {}, { "bearer": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string" }, "uploadId": { "type": "string" }, "parts": { "type": "array", "items": { "type": "object", "properties": { "partNumber": { "type": "integer" }, "etag": { "type": "string" } } } }, "fileName": { "type": "string" }, "fileSize": { "type": "integer" }, "contentType": { "type": "string" }, "folderId": { "type": "string" } }, "required": [ "key", "uploadId", "parts" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "file": { "$ref": "#/components/schemas/UploadedFile" } } } } } }, "400": { "$ref": "#/components/responses/E400" }, "404": { "$ref": "#/components/responses/E404" }, "413": { "$ref": "#/components/responses/E413" }, "507": { "$ref": "#/components/responses/E507" } } } }, "/api/files/multipart/abort": { "post": { "summary": "Abort a multipart upload", "tags": [ "Upload" ], "security": [ {}, { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string" }, "uploadId": { "type": "string" } }, "required": [ "key", "uploadId" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/E400" } } } }, "/api/files/remote-upload": { "post": { "summary": "Upload from a URL", "tags": [ "Upload" ], "security": [ {}, { "bearer": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "folderId": { "type": "string" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "const": true }, "data": { "$ref": "#/components/schemas/UploadedFile" } }, "required": [ "success", "data" ] } } } }, "400": { "$ref": "#/components/responses/E400" }, "404": { "$ref": "#/components/responses/E404" }, "429": { "$ref": "#/components/responses/E429" }, "502": { "$ref": "#/components/responses/E502" } } } }, "/api/files/remote-upload/info": { "post": { "summary": "Check a remote source", "tags": [ "Upload" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "url": { "type": "string" }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "integer" }, "acceptsRanges": { "type": "boolean" }, "multipartEligible": { "type": "boolean" }, "maxFileBytes": { "type": "integer" }, "withinLimit": { "type": "boolean" } } } }, "required": [ "success", "data" ] } } } }, "400": { "$ref": "#/components/responses/E400" } } } }, "/api/files/remote-upload/multipart/init": { "post": { "summary": "Start a large URL upload", "tags": [ "Upload" ], "security": [ {}, { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "folderId": { "type": "string" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "uploadId": { "type": "string" }, "key": { "type": "string" }, "url": { "type": "string" }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "totalSize": { "type": "integer" }, "partSize": { "type": "integer" }, "totalParts": { "type": "integer" }, "folderId": { "type": [ "string", "null" ] } } } }, "required": [ "success", "data" ] } } } }, "400": { "$ref": "#/components/responses/E400" }, "404": { "$ref": "#/components/responses/E404" }, "422": { "$ref": "#/components/responses/E422" } } } }, "/api/files/remote-upload/multipart/part": { "post": { "summary": "Transfer one part of a large URL upload", "tags": [ "Upload" ], "security": [ {}, { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" }, "key": { "type": "string" }, "uploadId": { "type": "string" }, "partNumber": { "type": "integer" }, "totalSize": { "type": "integer" }, "partSize": { "type": "integer" } }, "required": [ "url", "key", "uploadId", "partNumber", "totalSize", "partSize" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "partNumber": { "type": "integer" }, "etag": { "type": "string" } } } }, "required": [ "success", "data" ] } } } }, "400": { "$ref": "#/components/responses/E400" }, "404": { "$ref": "#/components/responses/E404" }, "429": { "$ref": "#/components/responses/E429" } } } }, "/api/files/remote-upload/multipart/complete": { "post": { "summary": "Finish a large URL upload", "tags": [ "Upload" ], "security": [ {}, { "bearer": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string" }, "uploadId": { "type": "string" }, "parts": { "type": "array", "items": { "type": "object", "properties": { "partNumber": { "type": "integer" }, "etag": { "type": "string" } } } }, "fileName": { "type": "string" }, "fileSize": { "type": "integer" }, "contentType": { "type": "string" }, "folderId": { "type": "string" } }, "required": [ "key", "uploadId", "parts" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "const": true }, "data": { "$ref": "#/components/schemas/UploadedFile" } }, "required": [ "success", "data" ] } } } }, "400": { "$ref": "#/components/responses/E400" }, "404": { "$ref": "#/components/responses/E404" } } } }, "/api/files/remote-upload/multipart/abort": { "post": { "summary": "Abort a large URL upload", "tags": [ "Upload" ], "security": [ {}, { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string" }, "uploadId": { "type": "string" } }, "required": [ "key", "uploadId" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/E400" } } } }, "/api/files/download/{fileId}": { "get": { "summary": "Get a signed download URL (valid 1 hour)", "tags": [ "Files" ], "security": [], "parameters": [ { "name": "fileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "url": { "type": "string" }, "fileName": { "type": "string" }, "size": { "type": "integer" }, "mimeType": { "type": "string" }, "expiresIn": { "type": "integer" }, "expiresAt": { "type": [ "string", "null" ] }, "downloads": { "type": "integer" }, "canDelete": { "type": "boolean" }, "shortId": { "type": "string" } } } }, "required": [ "success", "data" ] } } } }, "403": { "$ref": "#/components/responses/E403" }, "404": { "$ref": "#/components/responses/E404" } } } }, "/api/files/{id}": { "get": { "summary": "Get a file's metadata", "tags": [ "Files" ], "description": "Requires the list permission.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "const": true }, "data": { "$ref": "#/components/schemas/FileMetadata" } }, "required": [ "success", "data" ] } } } }, "401": { "$ref": "#/components/responses/E401" }, "403": { "$ref": "#/components/responses/E403" }, "404": { "$ref": "#/components/responses/E404" } } }, "patch": { "summary": "Rename or move a file", "tags": [ "Files" ], "description": "Requires the upload permission. Send at least one field.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "folderId": { "type": [ "string", "null" ] } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "const": true }, "data": { "$ref": "#/components/schemas/FileMetadata" } }, "required": [ "success", "data" ] } } } }, "400": { "$ref": "#/components/responses/E400" }, "401": { "$ref": "#/components/responses/E401" }, "403": { "$ref": "#/components/responses/E403" }, "404": { "$ref": "#/components/responses/E404" } } } }, "/api/files/info": { "get": { "summary": "Look up files by short ID (DDownload-compatible)", "tags": [ "Files" ], "security": [], "parameters": [ { "name": "file_code", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Comma-separated shortIds" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "msg": { "type": "string" }, "server_time": { "type": "string" }, "status": { "type": "integer" }, "result": { "type": "array", "items": { "type": "object" } } } } } } }, "400": { "description": "file_code missing" } } } }, "/api/files/list": { "get": { "summary": "List files", "tags": [ "Files" ], "description": "Requires the list permission. Uses snake_case fields.", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 200 } }, { "name": "folderId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Folder id, or null for the root" }, { "name": "includeFolders", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "mimeType", "in": "query", "required": false, "schema": { "type": "string" }, "description": "MIME prefix, e.g. image/" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object" } }, "folders": { "type": "array", "items": { "type": "object" } }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "limit": { "type": "integer" }, "total": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } } }, "401": { "$ref": "#/components/responses/E401" }, "403": { "$ref": "#/components/responses/E403" } } } }, "/api/files/delete": { "delete": { "summary": "Delete a file", "tags": [ "Files" ], "description": "With an API key from the same account, or the anonymous upload's deletion token.", "security": [ {}, { "bearer": [] } ], "parameters": [ { "name": "fileId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Deletion token of an anonymous upload" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } } } } }, "400": { "$ref": "#/components/responses/E400" }, "403": { "$ref": "#/components/responses/E403" }, "404": { "$ref": "#/components/responses/E404" } } } }, "/api/files/batch-delete": { "post": { "summary": "Delete up to 100 files", "tags": [ "Files" ], "description": "Requires the delete permission.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fileIds": { "type": "array", "items": { "type": "string" }, "maxItems": 100 } }, "required": [ "fileIds" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "fileId": { "type": "string" }, "success": { "type": "boolean" }, "error": { "type": "string" } } } }, "deletedCount": { "type": "integer" } } } }, "required": [ "success", "data" ] } } } }, "400": { "$ref": "#/components/responses/E400" }, "401": { "$ref": "#/components/responses/E401" }, "403": { "$ref": "#/components/responses/E403" } } } }, "/api/folders": { "get": { "summary": "List folders", "tags": [ "Folders" ], "description": "Requires the list permission.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "folders": { "type": "array", "items": { "$ref": "#/components/schemas/Folder" } } } } }, "required": [ "success", "data" ] } } } }, "401": { "$ref": "#/components/responses/E401" }, "403": { "$ref": "#/components/responses/E403" } } }, "post": { "summary": "Create a folder", "tags": [ "Folders" ], "description": "Requires the upload permission.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parentId": { "type": "string" }, "findOrCreate": { "type": "boolean" } }, "required": [ "name" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "folder": { "$ref": "#/components/schemas/Folder" } } } }, "required": [ "success", "data" ] } } } }, "400": { "$ref": "#/components/responses/E400" }, "401": { "$ref": "#/components/responses/E401" }, "403": { "$ref": "#/components/responses/E403" }, "404": { "$ref": "#/components/responses/E404" } } } }, "/api/folders/list": { "get": { "summary": "List folders (paged)", "tags": [ "Folders" ], "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "parentId", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "$ref": "#/components/responses/E401" }, "403": { "$ref": "#/components/responses/E403" } } } }, "/api/folders/{id}": { "get": { "summary": "Preview what deleting a folder removes", "tags": [ "Folders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "folderCount": { "type": "integer" }, "fileCount": { "type": "integer" } } } }, "required": [ "success", "data" ] } } } }, "401": { "$ref": "#/components/responses/E401" }, "403": { "$ref": "#/components/responses/E403" }, "404": { "$ref": "#/components/responses/E404" } } }, "patch": { "summary": "Rename, move, share or unshare a folder", "tags": [ "Folders" ], "description": "Body is {name}, {action:'move', parentId}, {action:'share', role?} or {action:'unshare'}. role sets what the share link allows: 'view' (browse and download), 'upload' (also add files and subfolders, remove own uploads) or 'edit' (also rename and delete anything inside). A folder shared afresh without a role is view-only. Share responds with {shareCode, role}.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "action": { "type": "string", "enum": [ "move", "share", "unshare" ] }, "parentId": { "type": [ "string", "null" ] }, "role": { "type": "string", "enum": [ "view", "upload", "edit" ] } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "const": true }, "data": { "type": "object" } }, "required": [ "success", "data" ] } } } }, "400": { "$ref": "#/components/responses/E400" }, "401": { "$ref": "#/components/responses/E401" }, "403": { "$ref": "#/components/responses/E403" }, "404": { "$ref": "#/components/responses/E404" } } }, "delete": { "summary": "Delete a folder, its subfolders and their files", "tags": [ "Folders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } }, "401": { "$ref": "#/components/responses/E401" }, "403": { "$ref": "#/components/responses/E403" }, "404": { "$ref": "#/components/responses/E404" } } } }, "/api/account": { "get": { "summary": "Account, storage, limits and rate limit", "tags": [ "Account" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "const": true }, "data": { "type": "object" } }, "required": [ "success", "data" ] } } } }, "401": { "$ref": "#/components/responses/E401" } } } }, "/api/webhooks/test": { "post": { "summary": "Send a test webhook event", "tags": [ "Webhooks" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "delivered": { "type": "boolean" }, "status": { "type": [ "integer", "null" ] }, "durationMs": { "type": "integer" }, "deliveryId": { "type": "string" } } } }, "required": [ "success", "data" ] } } } }, "400": { "$ref": "#/components/responses/E400" }, "401": { "$ref": "#/components/responses/E401" } } } }, "/api/v1/images/{key}": { "put": { "summary": "Upload or replace an image at a path", "tags": [ "Image hosting" ], "description": "Raw image bytes; png, jpeg, gif, webp, avif, bmp or x-icon; 20MB max. Requires upload permission.", "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "image/*": { "schema": { "type": "string", "format": "binary" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "key": { "type": "string" }, "shortId": { "type": "string" }, "url": { "type": "string" }, "cdnUrl": { "type": "string" }, "size": { "type": "integer" }, "mimeType": { "type": "string" }, "updated": { "type": "boolean" } } } }, "required": [ "success", "data" ] } } } }, "400": { "$ref": "#/components/responses/E400" }, "403": { "$ref": "#/components/responses/E403" }, "413": { "$ref": "#/components/responses/E413" }, "507": { "$ref": "#/components/responses/E507" } } }, "get": { "summary": "Look up the image at a path", "tags": [ "Image hosting" ], "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "const": true }, "data": { "type": "object" } }, "required": [ "success", "data" ] } } } }, "403": { "$ref": "#/components/responses/E403" }, "404": { "$ref": "#/components/responses/E404" } } }, "delete": { "summary": "Delete the image at a path", "tags": [ "Image hosting" ], "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } }, "403": { "$ref": "#/components/responses/E403" }, "404": { "$ref": "#/components/responses/E404" } } } } }, "components": { "securitySchemes": { "bearer": { "type": "http", "scheme": "bearer", "description": "Authorization: Bearer YOUR_API_KEY. The ?api_key= query parameter still works but is deprecated." } }, "parameters": { "IdempotencyKey": { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": "Makes retries safe: a repeat of a successful request returns the original response for 24 hours." } }, "schemas": { "UploadedFile": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string", "description": "Signed download URL, valid 24 hours" }, "mimeType": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "isAnonymous": { "type": "boolean" }, "expiresAt": { "type": [ "string", "null" ] }, "shortId": { "type": "string" }, "deletionToken": { "type": "string", "description": "Anonymous uploads only, shown once" } } }, "FileMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "size": { "type": "integer" }, "mimeType": { "type": "string" }, "shortId": { "type": "string" }, "folderId": { "type": [ "string", "null" ] }, "viewUrl": { "type": "string" }, "isAnonymous": { "type": "boolean" }, "createdAt": { "type": "string" }, "expiresAt": { "type": [ "string", "null" ] }, "downloadCount": { "type": "integer" } } }, "Folder": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "ownerId": { "type": "string" }, "createdAt": { "type": "integer" } } }, "Error": { "type": "object", "properties": { "success": { "const": false }, "error": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "success", "error" ] } }, "responses": { "E400": { "description": "invalid_request / invalid_url", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "E401": { "description": "missing_api_key / invalid_api_key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "E403": { "description": "permission_denied / forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "E404": { "description": "not_found / file_not_found / folder_not_found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "E413": { "description": "file_too_large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "E422": { "description": "unprocessable / unsupported_source", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "E429": { "description": "rate_limited (see Retry-After)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "E502": { "description": "upstream_error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "E507": { "description": "storage_quota_exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }