Skip to main content

​
Quick start

This guide will walk you through the essential steps to get started with Brautcloud. You’ll create an account, set up your first wedding event, upload photos, and share access with your guests.
1

Create your account

Start by registering for a Brautcloud account. You’ll need to provide your email and create a password.Registration request
curl -X POST https://your-brautcloud-instance.com/api/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "email": "sophie@example.com",
    "password": "your-secure-password"
  }'
The registration form captures:
  • Full name
  • Email address
  • Password (with confirmation)
<form class="flex flex-col gap-5 w-1/3">
  <input type="text" placeholder="Full Name" class="border-mainrose/50 border-2 px-4 py-2"/>
  <input type="email" placeholder="Email Address" class="border-mainrose/50 border-2 px-4 py-2"/>
  <input type="password" placeholder="Create password" class="border-mainrose/50 border-2 px-4 py-2"/>
  <input type="password" placeholder="Confirm password" class="border-mainrose/50 border-2 px-4 py-2"/>
  <button type="submit">CREATE ACCOUNT</button>
</form>
Once registered, you can log in to receive your JWT access token and refresh token for authenticated requests.
Login request
curl -X POST https://your-brautcloud-instance.com/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "sophie@example.com",
    "password": "your-secure-password"
  }'
Response
{
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
The refresh token is set as an HTTP-only cookie for security.
2

Create your first wedding event

After logging in, create your wedding event with details like the event name, date, location, and couple names.Create event request
curl -X POST https://your-brautcloud-instance.com/api/events \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{
    "userId": 1,
    "eventName": "Sophie & Marc Wedding",
    "location": "Garden Venue, California",
    "date": "2026-06-15T15:00:00",
    "password": "guest-access-password",
    "qrCode": "https://example.com/qr/sophie-marc"
  }'
The event includes:
  • eventName: The name of your wedding event
  • location: Where the wedding takes place
  • date: Wedding date and time (ISO 8601 format)
  • password: Password for guest access to the event
  • qrCode: Optional QR code for easy guest access
The event password allows guests to access and upload photos to your event gallery without creating their own accounts.
List your events
curl -X GET https://your-brautcloud-instance.com/api/events \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Response
[
  {
    "id": 1,
    "eventName": "Sophie & Marc Wedding",
    "location": "Garden Venue, California",
    "date": "2026-06-15T15:00:00",
    "userId": 1,
    "coupleName": "Sophie & Marc"
  }
]
3

Upload photos to your event

Now that your event is created, you and your guests can start uploading photos to build your wedding gallery.Upload image request
curl -X POST https://your-brautcloud-instance.com/api/image \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -F "file=@/path/to/photo.jpg" \
  -F "eventId=1"
The upload interface provides a simple camera-style upload experience:
<div class="text-center border-2 border-mainrose/30 rounded-full aspect-square p-20">
  <div class="material-symbols-outlined text-mainrose text-6xl">photo_camera</div>
  <p class="uppercase tracking-widest text-xs">Upload Photo</p>
</div>
<p class="uppercase text-mainrose mt-5 font-bold">Select from Gallery</p>
View uploaded photos
curl -X GET https://your-brautcloud-instance.com/api/image/1 \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
This returns all images associated with your event, stored securely in AWS S3.
Photos are automatically uploaded to S3 and associated with your event. Each upload is tracked so you can see who contributed to your gallery.
4

Share your event with guests

Share your wedding event with guests so they can upload their photos and view the gallery.Sharing options
  1. Event password: Share the event password with guests so they can access the event and upload photos
  2. QR code: Generate a QR code that links directly to your event upload page
  3. Direct link: Share the event URL with the event ID
Guest upload flowGuests visit your event page and see a personalized welcome:
<h1 class="font-display text-3xl text-center">Join Sophie & Marc's Celebration</h1>
<p class="font-body text-sm text-neutral-400 italic">
  Capture the love and share it with the couple.
</p>
They can then upload photos which appear in your shared gallery. The upload interface tracks their contributions:
<div class="flex justify-between items-center">
  <p class="font-display text-2xl">Your Uploads</p>
  <div class="flex items-center gap-2">
    <p class="font-body text-mainrose">3 Shared</p>
  </div>
</div>
All uploaded photos are immediately available in the event gallery for everyone to view and enjoy.

​
Next steps

Now that you’ve created your first event and uploaded photos, explore more features:

Build docs developers (and LLMs) love

Get started for freeTalk to us