SDK reference

Public API and SDK reference

Explore the public API contract and generate verified Java, TypeScript, Python, C#, and Go clients or SDK archives for SpecTestEngine testing.

Public integration contract

SDK & API reference

Explore the versioned OpenAPI contract and generate typed clients for Java, TypeScript, Python, C#, or Go.

SDK source on GitHub
143Public operations
13Workflow areas
161Shared schemas
5Verified clients
Project-scopedBearer access tokens
Version 1.0.0-alpha.7SpecTestEngine Public API
Browser visual reviews

Get a Browser visual comparison

GET/browser/visual/comparisons/{comparisonId}

Returns one immutable comparison generation, its evidence lineage, normalized exclusions, and currently available review actions.

preview Bearer tokenRetry-safe operationgetBrowserVisualComparison

Parameters

comparisonIdpathstring · uuidRequired

Identifier of an immutable Browser visual comparison generation.

Request body

No request body is required.

Responses

200Browser visual comparison scoped to the token company and active project.
application/jsonBrowserVisualComparison
comparisonIdrequired
string · uuid
statusrequired
decisionStatusrequired
scopeTyperequired
compareModerequired
stopPolicyrequired
baselineArtifactIdoptional
string · uuid
nullable
actualArtifactIdoptional
string · uuid
nullable
diffArtifactIdoptional
string · uuid
nullable
diffPixelsoptional
integer · int64
minimum: 0nullable
diffPixelRatiooptional
number · double
minimum: 0maximum: 1nullable
messageoptional
string
nullable
changedDetailsoptional
array<string>
changedRegionsoptional
array<BrowserVisualDiffRegion>
createdAtrequired
string · date-time
reviewedAtoptional
string · date-time
nullable
assertionRevisionrequired
integer · int64
minimum: 1
baselineRevisionIdoptional
string · uuid
nullable
appliedBaselineRevisionIdoptional
string · uuid
nullable
generationNumberrequired
integer
minimum: 1
sourceComparisonIdoptional
string · uuid
nullable
rootComparisonIdrequired
string · uuid
excludedRegionsrequired
array<BrowserVisualExcludedRegion>
max items: 250
changedExcludedRegionIndexesrequired
array<integer>
max items: 250
reviewCapabilitiesrequired
Example value
{
  "comparisonId": "0197f0ab-42e7-7a31-8a9c-591a8ee54c12",
  "status": "PASSED",
  "decisionStatus": "UNREVIEWED",
  "scopeType": "PAGE",
  "compareMode": "STRICT",
  "stopPolicy": "STOP_RUN",
  "baselineArtifactId": "0197f0ab-42e7-7a31-8a9c-591a8ee54c12",
  "actualArtifactId": "0197f0ab-42e7-7a31-8a9c-591a8ee54c12",
  "diffArtifactId": "0197f0ab-42e7-7a31-8a9c-591a8ee54c12",
  "diffPixels": 0,
  "diffPixelRatio": 0,
  "message": "string",
  "changedDetails": [
    "string"
  ],
  "changedRegions": [
    {
      "x": 0,
      "y": 0,
      "width": 0,
      "height": 0,
      "diffPixels": 0,
      "leftRatio": 0,
      "topRatio": 0,
      "widthRatio": 0,
      "heightRatio": 0
    }
  ],
  "createdAt": "2026-07-16T12:00:00Z",
  "reviewedAt": "2026-07-16T12:00:00Z",
  "assertionRevision": 0,
  "baselineRevisionId": "0197f0ab-42e7-7a31-8a9c-591a8ee54c12",
  "appliedBaselineRevisionId": "0197f0ab-42e7-7a31-8a9c-591a8ee54c12",
  "generationNumber": 0,
  "sourceComparisonId": "0197f0ab-42e7-7a31-8a9c-591a8ee54c12",
  "rootComparisonId": "0197f0ab-42e7-7a31-8a9c-591a8ee54c12",
  "excludedRegions": [
    {
      "xRatio": 0,
      "yRatio": 0,
      "widthRatio": 0,
      "heightRatio": 0,
      "reason": "string"
    }
  ],
  "changedExcludedRegionIndexes": [
    0
  ],
  "reviewCapabilities": {
    "useCurrentAsNewBaseline": {
      "available": true,
      "state": "AVAILABLE",
      "disabledReason": "string"
    },
    "excludeAreaAndRecompare": {
      "available": true,
      "state": "AVAILABLE",
      "disabledReason": "string"
    },
    "keepAsRegression": {
      "available": true,
      "state": "AVAILABLE",
      "disabledReason": "string"
    }
  }
}
defaultThe request failed.
application/jsonProblemDetails
timestamprequired
string · date-time
statusrequired
integer
errorrequired
string
messagerequired
string
pathrequired
string
errorCoderequired
string
translationKeyoptional
string
nullable
requestIdoptional
string
nullable
violationsoptional
array<object>
Example value
{
  "timestamp": "2026-07-16T12:00:00Z",
  "status": 0,
  "error": "string",
  "message": "string",
  "path": "string",
  "errorCode": "string",
  "translationKey": "string",
  "requestId": "string",
  "violations": [
    {}
  ]
}

Referenced schemas