Get started with the Mosaically API in minutes. This guide shows you how to add, remove, and update photos in your mosaic programmatically—plus how to trigger a fresh render whenever needed.
Start by creating a mosaic through the regular Mosaically website. Once created, navigate to your mosaic page.
Your mosaic URL will look like this:
https://mosaically.com/photomosaic/7d3a48cf-d25a-45a9-94a5-3e8ce21e1f06
Extract the mosaic_id from the URL. In the example above:
mosaic_id = 7d3a48cf-d25a-45a9-94a5-3e8ce21e1f06
Make a POST request to the /api/Photo endpoint.
api_key: Your private API keymosaic_id: Your target mosaicsource: Direct URL to the image you want to addname: Name of the photodescription: Description of the photoExample:
POST https://mosaically.com/api/Photo?api_key=YOUR_KEY&mosaic_id=YOUR_ID&source=https://example.com/photo.jpg&name=Uncle+Bob&description=Family+BBQ
photo_id (GUID). Keep this ID to update or remove the photo later.
Make a DELETE request with:
api_keymosaic_idphoto_id: ID of the photo to removeExample:
DELETE https://mosaically.com/api/Photo?api_key=YOUR_KEY&mosaic_id=YOUR_ID&photo_id=PHOTO_ID
Returns: true on success.
Use a PUT request to update a photo’s name or description.
api_keyphoto_idname (optional)description (optional)Example:
PUT https://mosaically.com/api/Photo?api_key=YOUR_KEY&photo_id=PHOTO_ID&name=New+Name&description=Updated+description
Returns: true on success.
After adding or removing photos, call the following endpoint to rebuild your mosaic:
POST https://mosaically.com/api/RenderRequest?api_key=YOUR_KEY&mosaic_id=YOUR_ID
Returns: true if the render job is accepted.
Once rendering is complete, your mosaic is updated live:
https://mosaically.com/photomosaic/{mosaic_id}
Embedded versions will update within about a minute.