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

Build against one reviewed API, in the language your team already uses.

Browse the complete SpecTestEngine public contract, inspect every operation, and generate typed Java, TypeScript, Python, C#, or Go clients from the same versioned OpenAPI source used by this guide.

134Public operations
13Workflow areas
148Shared schemas
5Verified clients
Project-scopedBearer access tokens
Version 1.0.0-alpha.5SpecTestEngine 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

No additional description.

statusrequired

No additional description.

decisionStatusrequired

No additional description.

scopeTyperequired

No additional description.

compareModerequired

No additional description.

stopPolicyrequired

No additional description.

baselineArtifactIdoptional
string · uuid

No additional description.

nullable
actualArtifactIdoptional
string · uuid

No additional description.

nullable
diffArtifactIdoptional
string · uuid

No additional description.

nullable
diffPixelsoptional
integer · int64

No additional description.

minimum: 0nullable
diffPixelRatiooptional
number · double

No additional description.

minimum: 0maximum: 1nullable
messageoptional
string

No additional description.

nullable
changedDetailsoptional
array<string>

No additional description.

changedRegionsoptional
array<BrowserVisualDiffRegion>

No additional description.

createdAtrequired
string · date-time

No additional description.

reviewedAtoptional
string · date-time

No additional description.

nullable
assertionRevisionrequired
integer · int64

No additional description.

minimum: 1
baselineRevisionIdoptional
string · uuid

No additional description.

nullable
appliedBaselineRevisionIdoptional
string · uuid

No additional description.

nullable
generationNumberrequired
integer

No additional description.

minimum: 1
sourceComparisonIdoptional
string · uuid

No additional description.

nullable
rootComparisonIdrequired
string · uuid

No additional description.

excludedRegionsrequired
array<BrowserVisualExcludedRegion>

No additional description.

max items: 250
changedExcludedRegionIndexesrequired
array<integer>

No additional description.

max items: 250
reviewCapabilitiesrequired

No additional description.

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

No additional description.

statusrequired
integer

No additional description.

errorrequired
string

No additional description.

messagerequired
string

No additional description.

pathrequired
string

No additional description.

errorCoderequired
string

No additional description.

translationKeyoptional
string

No additional description.

nullable
requestIdoptional
string

No additional description.

nullable
violationsoptional
array<object>

No additional description.

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