Diffy API Documentation

This is the complete API documentation for connecting to the Diffy API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet Diffy: Create visual tests, compare screenshots, and review diffs. Keep reading to get started.

Quickstart

Before you run your first Diffy request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one Diffy connection — create or choose one in Connections. Note its connectionId.

Every Diffy action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/diffy/latest/actions/{actionSlug}

You need a MindCloud API Key and a Diffy connection. Then call an action such as Get Diff:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/diffy/latest/actions/get-diff" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Diffy account that should run the action. MindCloud stores and refreshes the Diffy credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

Diffy actions

All 22 published actions for this Diffy version. Each page documents the endpoint, arguments, and response controls.

• POSTCompare Environments
• POSTCreate Custom Uploaded Screenshot
• POSTCreate Diff
• POSTCreate Project
• POSTCreate Screenshot
• DELETEDelete Diff
• DELETEDelete Project
• DELETEDelete Screenshot
• POSTExchange API Key for Token
• GETGet Diff
• GETGet Project
• GETGet Screenshot
• GETList Project Diffs
• GETList Project Screenshots
• GETList Projects
• PUTSet Baseline Image
• PUTSet Screenshot Set as Baseline
• PUTStart or Stop Diff Jobs
• PUTStart or Stop Screenshot Jobs
• PUTUpdate Diff Name
• PUTUpdate Project
• PUTUpdate Screenshot

Related apps

More IT Operations apps on the Universal API, behind the same REST shape. Or browse all apps.

GitHubNetlifyMySQLPostgreSQLFirebasePagerDutyGoogle Workspace AdminAdalo