Files
Upload files to bucket
Upload one or more files to a storage bucket using multipart/form-data. Per-file size is limited by the org plan (`maxFileUploadBytes`) and bucket `maxFileSize`, whichever is stricter. Exceeding the limit returns **413**. Accepts: OrgBearerAuth (for admin users), ProjectBearerAuth (JWT for authenticated users), or ApiKeyAuth (X-API-Key for programmatic access). Both ProjectBearerAuth and ApiKeyAuth are fully implemented.
/api/bucket/projects/{projectId}/buckets/{bucketId}/filesSDK setup
Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.
import { Configuration, FilesApi } from 'mudbase-sdk';
const configuration = new Configuration({
basePath: 'https://cloud.mudbase.dev',
apiKey: 'sk_live_mudbase_doc_Xk9mP2qR7vN4wL8jH3tY6uE',
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
// This endpoint accepts either credential — apiKey or accessToken alone is enough.
const files = new FilesApi(configuration);import { Configuration, FilesApi } from 'mudbase-sdk';
const configuration = new Configuration({
basePath: 'https://cloud.mudbase.dev',
apiKey: 'sk_live_mudbase_doc_Xk9mP2qR7vN4wL8jH3tY6uE',
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
// This endpoint accepts either credential — apiKey or accessToken alone is enough.
const files = new FilesApi(configuration);Example request
Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.
const { data: result } = await files.uploadFiles("proj_jdHIurqwStDt", "zO2I9YXt2M0sAUti");const { data: result } = await files.uploadFiles("proj_jdHIurqwStDt", "zO2I9YXt2M0sAUti");Playground
liveTest this endpoint with your own credentials. Your requests will be sent to the live API.
No Request Yet
Send a request to see the full inspector
Authentication
Authorization: Bearer YOUR_TOKEN for user context, or X-API-Key: YOUR_KEY for server-to-server. View authentication guide →Include your JWT in the Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →Include your API key in the X-API-Key: YOUR_KEY header (server-to-server, SDKs). View authentication guide →Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | — |
bucketId | string | Yes | — |
Request Body
{}{}Responses
{
"message": "Files uploaded successfully",
"file": {
"_id": "685af8b85d73a104065b6a77",
"name": "example.pdf",
"size": 1024000,
"mimeType": "application/pdf",
"bucket": "65a1b2c3d4e5f6789012345a",
"url": "https://storage.example.com/files/685af8b85d73a104065b6a77",
"createdAt": "2024-01-15T10:00:00.000Z"
}
}{
"message": "Files uploaded successfully",
"file": {
"_id": "685af8b85d73a104065b6a77",
"name": "example.pdf",
"size": 1024000,
"mimeType": "application/pdf",
"bucket": "65a1b2c3d4e5f6789012345a",
"url": "https://storage.example.com/files/685af8b85d73a104065b6a77",
"createdAt": "2024-01-15T10:00:00.000Z"
}
}Errors
| Code | Meaning |
|---|---|
400 | — |
401 | — |
403 | — |
409 | — |
413 | — |
429 | — |
500 | — |