POST /version — add a new version to a project

Use this endpoint to add a new version to an existing project. You can submit a website URL, a single file (PDF, image, video, or audio), or up to 25 images at once. All variants return a new version ID and a shareable review link.

Endpoint

POST https://api.bugsmash.io/api/v2/version

Authentication

All requests require the X-API-Key header.

X-API-Key: YOUR_API_KEY

Request variants

Website
Single file
Multiple images

Send a JSON body with the website URL and the target project ID.Content-Type: application/json

Body parameters

string

required

The full URL of the website to capture as a new version.

uuid

required

The unique identifier of the project to add this version to.

Request example

curl --location 'https://api.bugsmash.io/api/v2/version' \
--header 'X-API-Key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
  "websiteUrl": "https://example.com",
  "projectId": "a1732b1e-4b43-4217-a780-c521a98aaeea"
}'

Upload a single file using multipart form data. Supported formats: PDF, image, video, and audio.Content-Type: multipart/form-data

Form parameters

file

required

The file to upload. Accepted formats: PDF, PNG, JPG, MP4, MP3, and other common image, video, and audio types.

string

required

The unique identifier of the project to add this version to.

Request example

curl --location 'https://api.bugsmash.io/api/v2/project/generate-review-link' \
--header 'X-API-Key: YOUR_API_KEY' \
--form 'file=@"/path/to/your/file.pdf"' \
--form 'projectId="a1732b1e-4b43-4217-a780-c521a98aaeea"'

Upload up to 25 images at once using multipart form data.Content-Type: multipart/form-data

Form parameters

file[]

required

An array of image files to upload. Maximum of 25 images per request.

string

required

The unique identifier of the project to add this version to.

Request example

curl --location 'https://api.bugsmash.io/api/v2/project/generate-review-link' \
--header 'X-API-Key: YOUR_API_KEY' \
--form 'files[]=@"/path/to/thumbnail.png"' \
--form 'files[]=@"/path/to/poster.png"' \
--form 'projectId="a1732b1e-4b43-4217-a780-c521a98aaeea"'

Response example

The response is the same for all three variants.

{
  "status": true,
  "message": "Version successfully added",
  "version": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "V2",
    "review_link": "https://app.bugsmash.io/review/AbCdE"
  }
}

Response fields

boolean

Whether the request was successful.

string

Human-readable description of the result.

object

Details of the newly created version.

Show properties

string

UUID of the newly created version.

string

Auto-assigned version label, such as "V2".

string

Shareable link you can send to reviewers to access this version.

Folders

Versions

Projects

Comments

Webhooks

POST /version — add a new version to a project

Endpoint

Authentication

Request variants

Body parameters

Request example

Form parameters

Request example

Form parameters

Request example

Response example

Response fields

​Endpoint

​Authentication

​Request variants

​Body parameters

​Request example

​Form parameters

​Request example

​Form parameters

​Request example

​Response example

​Response fields

Endpoint

Authentication

Request variants

Body parameters

Request example

Form parameters

Request example

Form parameters

Request example

Response example

Response fields