POST /project/generate-review-link — create a project

This is the primary endpoint for creating a new Bugsmash review project. You can submit a website URL for live site review, upload a single file for PDF, video, or audio projects, or upload up to 25 images in one request. The response includes a unique review link you can share directly with reviewers.

POST https://api.bugsmash.io/api/v2/project/generate-review-link

Request headers

string

required

Your Bugsmash API key.

Request body

Website
Files (PDF / Video / Audio)
Images

Send a JSON body with Content-Type: application/json.

string

required

Display name for the project.

string

required

Must be "website" for this variant.

string

required

The URL of the website to review.

boolean

When true, guests can leave comments without logging in.

boolean

When true, each guest sees only their own comments. Requires anonymousComments: false.

curl --location 'https://api.bugsmash.io/api/v2/project/generate-review-link' \
--header 'X-API-Key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
  "projectName": "Website Review",
  "projectType": "website",
  "websiteUrl": "https://example.com",
  "anonymousComments": true
}'

{
  "status": true,
  "message": "Success",
  "project": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Website Review",
    "review_link": "https://app.bugsmash.io/review/AbCdE"
  }
}

Send a multipart/form-data request with a single file attachment.

string

required

Display name for the project.

string

required

One of "pdf", "video", or "audio".

file

required

The file to upload.

boolean

When true, guests can leave comments without logging in.

boolean

When true, each guest sees only their own comments. Requires anonymousComments: false.

curl --location 'https://api.bugsmash.io/api/v2/project/generate-review-link' \
--header 'X-API-Key: YOUR_API_KEY' \
--form 'projectType="pdf"' \
--form 'anonymousComments="true"' \
--form 'file=@"/path/to/your/file.pdf"' \
--form 'projectName="Home Screen Design"'

{
  "status": true,
  "message": "Success",
  "project": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Home Screen Design",
    "review_link": "https://app.bugsmash.io/review/FgHiJ"
  }
}

Send a multipart/form-data request with one or more image files. You can upload up to 25 images in a single request; Bugsmash creates a multi-frame project from them.

string

required

Display name for the project.

string

required

Must be "image" for this variant.

file[]

required

Array of image files to upload. Maximum 25 images per request.

boolean

When true, guests can leave comments without logging in.

boolean

When true, each guest sees only their own comments. Requires anonymousComments: false.

curl --location 'https://api.bugsmash.io/api/v2/project/generate-review-link' \
--header 'X-API-Key: YOUR_API_KEY' \
--form 'projectType="image"' \
--form 'files[]=@"/path/to/thumbnail.png"' \
--form 'files[]=@"/path/to/poster.png"' \
--form 'files[]=@"/path/to/background.png"' \
--form 'projectName="Q2 Social Creatives"' \
--form 'anonymousComments="false"'

{
  "status": true,
  "message": "Success",
  "project": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Q2 Social Creatives",
    "review_link": "https://app.bugsmash.io/review/KlMnO"
  }
}

Response fields

boolean

required

true when the request succeeded.

string

required

Human-readable status message.

object

required

Hide properties

string

required

UUID of the newly created project.

string

required

Display name of the project as stored.

string

required

Shareable URL to send to reviewers. Anyone with this link can open the review interface.

Folders

Versions

Projects

Comments

Webhooks

POST /project/generate-review-link — create a project

Request headers

Request body

Response fields

​Request headers

​Request body

​Response fields

Request headers

Request body

Response fields