BugSmash API Docs
Written By Team BugSmash
Last updated 9 days ago
Please refer to our new v2 API Docs here: https://bugsmash.featurebase.app/en/help/collections/9484967-bugsmash-api-docs
Below API document describes how you can easily use the BugSmash API to generate review link on-the-fly from any of your systems and workflows
Generate Review Link
ExampleAPI --
https://api.bugsmash.io/api/v2/project/generate-review-link
HEADER --
X-API-Key: YOUR_API_KEY
REQUEST --
--------- For Websites: ---------
Header: Content-Type: application/json
JSON Body
{
"project_name":"Testing project",
"project_type":"website",
"website_url":"https://tailwindcss.com",
"anonymous_comments": true/false // If enabled, guests can leave comments without even logging in
"private_comments": true/false // If enabled, guests would be able to see only their own comments. (This mode needs anonymous_comments to be set to false)
}
--------- For Files (PDF/Image/Video/Audio): ---------
Header: Content-Type: multipart/form-data
Form Data -
{
"project_name":"Testing project",
"project_type":"pdf", // Accepts these values: image/pdf/video/audio
"file": YOUR_FILE_HERE,
"anonymous_comments": true/false // If enabled, guests can leave comments without even logging in
"private_comments": true/false // If enabled, guests would see only their own comments. (This mode needs anonymous_comments to be set to false)
}
--------- For multiple image files in a single project: ---------
Header: Content-Type: multipart/form-data
Form Data -
{
"project_name": "2026-Q2-Social-BrandAwareness",
"project_type":"multi_images",
"files[]": YOUR_FILE_ARRAY_HERE, //Accepts upto 25 images at once within the array
"anonymous_comments": true/false // If enabled, guests can leave comments without even logging in
"private_comments": true/false // If enabled, guests would see only their own comments. (This mode needs anonymous_comments to be set to false)
}
Curl URL example -
curl --location 'https://api.bugsmash.io/api/v2/project/generate-review-link' \
--header 'X-API-Key: YOUR_API_KEY' \
--form 'project_type="multi_images"' \
--form 'files[]=@"/home/BugSmashTeam/Downloads/image1.png"' \
--form 'files[]=@"/home/BugSmashTeam/Downloads/image2.png"' \
--form 'files[]=@"/home/BugSmashTeam/Downloads/image3.png"' \
--form 'project_name="2026-Q2-Social-BrandAwareness"' \
--form 'anonymous_comments="false"'
RESPONSE --
{
"status":true,
"message":"Success",
"project":{
"id":"9fde3ba0-7928-4a3a-8e8b-XXXX",
"name": "2026-Q2-Social-BrandAwareness",
"review_link": "https://review.bugsmash.io/XXXX"
},
}