storage

Upload files to bucket

Upload one or more files to a storage bucket using multipart/form-data. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key).

POST/api/bucket/projects/{projectId}/buckets/{bucketId}/files

Authentication

Requires JWT Requires API Key JWT or API Key
Note
This endpoint accepts either JWT Bearer token or API Key. Use 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

NameTypeRequiredDescription
projectIdstringYesProject ID.
bucketIdstringYesBucket ID.

Request Body

Use multipart/form-data for file upload (files required; optional folder, tags). application/json uses the same schema for metadata-only or tooling that prefers JSON.

json
{
  "files": [
    "feed copy"
  ],
  "folder": "program index",
  "tags": [
    "pixel back up"
  ]
}
{
  "files": [
    "feed copy"
  ],
  "folder": "program index",
  "tags": [
    "pixel back up"
  ]
}

SDK setup

Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.

import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");
import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");

Example request

Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.

const result = await client.storage.uploadFiles({
  projectId: "proj_SjD69AxGqP16",
  bucketId: "eaU49f4F5DWf0lJJ",
  files: "card index",
  folder: "port transmit",
  tags: "matrix bypass"
});
const result = await client.storage.uploadFiles({
  projectId: "proj_SjD69AxGqP16",
  bucketId: "eaU49f4F5DWf0lJJ",
  files: "card index",
  folder: "port transmit",
  tags: "matrix bypass"
});

Try It Live

Test this endpoint with your own credentials. Your requests will be sent to the live API.

Get your API key from the console
Use the auth endpoints to obtain a JWT.

No Request Yet

Send a request to see the full inspector

Responses

201Files uploaded successfully
json
{
  "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"
  }
}
400Bad request or validation error.
401Authentication required or invalid token.
403Access denied or insufficient permissions.
409Conflict (e.g. resource already exists or state conflict).
429Rate limit exceeded.
500Internal server error.

Errors

CodeMeaning
400Bad request or validation error.
401Authentication required or invalid token.
403Access denied or insufficient permissions.
409Conflict (e.g. resource already exists or state conflict).
429Rate limit exceeded.
500Internal server error.

Next steps

Edit this page on GitHub