> For the complete documentation index, see [llms.txt](https://argos-ci.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://argos-ci.com/docs/api-reference/reference/models.md).

# Models

## The Sha1Hash object

```json
{"openapi":"3.2.0","info":{"title":"Argos API","version":"2.0.0"},"components":{"schemas":{"Sha1Hash":{"type":"string","pattern":"^[0-9a-f]{40}$","description":"SHA1 hash"}}}}
```

## The GitBranch object

```json
{"openapi":"3.2.0","info":{"title":"Argos API","version":"2.0.0"},"components":{"schemas":{"GitBranch":{"type":"string","minLength":1}}}}
```

## The Sha256Hash object

```json
{"openapi":"3.2.0","info":{"title":"Argos API","version":"2.0.0"},"components":{"schemas":{"Sha256Hash":{"type":"string","pattern":"^[A-Fa-f0-9]{64}$","description":"SHA256 hash"}}}}
```

## The ScreenshotUploadRequest object

```json
{"openapi":"3.2.0","info":{"title":"Argos API","version":"2.0.0"},"components":{"schemas":{"ScreenshotUploadRequest":{"type":"object","properties":{"key":{"$ref":"#/components/schemas/Sha256Hash"},"contentType":{"description":"Content type of the snapshot file","type":"string"}},"required":["key","contentType"],"description":"Screenshot file to upload"},"Sha256Hash":{"type":"string","pattern":"^[A-Fa-f0-9]{64}$","description":"SHA256 hash"}}}}
```

## The BuildId object

```json
{"openapi":"3.2.0","info":{"title":"Argos API","version":"2.0.0"},"components":{"schemas":{"BuildId":{"type":"string","description":"A unique identifier for the build"}}}}
```

## The ScreenshotInput object

```json
{"openapi":"3.2.0","info":{"title":"Argos API","version":"2.0.0"},"components":{"schemas":{"ScreenshotInput":{"type":"object","properties":{"key":{"type":"string","pattern":"^[A-Fa-f0-9]{64}$"},"name":{"type":"string"},"baseName":{"anyOf":[{"type":"string"},{"type":"null"}]},"parentName":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"anyOf":[{"type":"object","properties":{"$schema":{"description":"Ignored. Can be set to get completions, validations and documentation in some editors.","type":"string"},"url":{"description":"The URL of the page that was screenshotted","anyOf":[{"type":"string"},{"type":"null"}]},"previewUrl":{"description":"An URL to an accessible preview of the screenshot","anyOf":[{"type":"string"},{"type":"null"}]},"viewport":{"anyOf":[{"type":"object","properties":{"width":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The width of the viewport"},"height":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The height of the viewport"}},"required":["width","height"],"description":"The viewport dimensions when the screenshot was taken"},{"type":"null"}]},"colorScheme":{"description":"The color scheme when the screenshot was taken","anyOf":[{"type":"string","enum":["light","dark"]},{"type":"null"}]},"mediaType":{"description":"The media type when the screenshot was taken","anyOf":[{"type":"string","enum":["screen","print"]},{"type":"null"}]},"test":{"anyOf":[{"type":"object","properties":{"id":{"description":"The unique identifier of the test","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string","description":"The title of the test"},"titlePath":{"type":"array","items":{"type":"string"},"description":"The path of titles leading to the test"},"retries":{"description":"The number of retries for the test","anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"retry":{"description":"The current retry count","anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"repeat":{"description":"The repeat count for the test","anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"location":{"description":"The location of the test in the source code","type":"object","properties":{"file":{"type":"string","description":"The located file"},"line":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The line number in the file"},"column":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The column number in the file"}},"required":["file","line","column"]},"annotations":{"description":"Annotations associated to the test","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of annotation"},"description":{"description":"The description of the annotation","type":"string"},"location":{"description":"The location of the annotation in the source code","type":"object","properties":{"file":{"type":"string","description":"The located file"},"line":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The line number in the file"},"column":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The column number in the file"}},"required":["file","line","column"]}},"required":["type"],"description":"A test annotation"}},"tags":{"description":"Tags associated to the test","type":"array","items":{"type":"string"}}},"required":["title","titlePath"],"description":"The test that generated the screenshot"},{"type":"null"}]},"browser":{"anyOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the browser"},"version":{"type":"string","description":"The version of the browser"}},"required":["name","version"],"description":"The browser that generated the screenshot"},{"type":"null"}]},"automationLibrary":{"type":"object","properties":{"name":{"type":"string","description":"The name of the automation library"},"version":{"type":"string","description":"The version of the automation library"}},"required":["name","version"],"description":"The automation library that generated the screenshot"},"sdk":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Argos SDK"},"version":{"type":"string","description":"The version of the Argos SDK"}},"required":["name","version"],"description":"The Argos SDK that generated the screenshot"},"story":{"description":"Storybook story metadata","anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the story"},"tags":{"description":"Tags attached to the story","type":"array","items":{"type":"string"}},"mode":{"description":"Story mode","type":"string"},"play":{"description":"True if the story has a play function","type":"boolean"}},"required":["id"],"description":"Storybook story metadata"},{"type":"null"}]},"tags":{"description":"Tags associated to the screenshot","type":"array","items":{"type":"string"}}},"required":["automationLibrary","sdk"],"description":"Metadata about a screenshot"},{"type":"null"}]},"pwTraceKey":{"anyOf":[{"type":"string","pattern":"^[A-Fa-f0-9]{64}$"},{"type":"null"}]},"threshold":{"anyOf":[{"type":"number","minimum":0,"maximum":1},{"type":"null"}]},"contentType":{"description":"Content type of the snapshot file","type":"string"}},"required":["key","name"],"description":"Screenshot input"}}}}
```

## The BuildMetadata object

```json
{"openapi":"3.2.0","info":{"title":"Argos API","version":"2.0.0"},"components":{"schemas":{"BuildMetadata":{"description":"Build metadata","type":"object","properties":{"testReport":{"description":"Test suite report","type":"object","properties":{"status":{"type":"string","enum":["passed","failed","timedout","interrupted"],"description":"Status of the test suite"},"stats":{"type":"object","properties":{"startTime":{"description":"Date when the test suite started","type":"string"},"duration":{"description":"Duration of the test suite in milliseconds","type":"number"}}}},"required":["status"]}}}}}}
```

## The BuildNumber object

```json
{"openapi":"3.2.0","info":{"title":"Argos API","version":"2.0.0"},"components":{"schemas":{"BuildNumber":{"description":"The build number","type":"string"}}}}
```

## The AccountAnalytics object

```json
{"openapi":"3.2.0","info":{"title":"Argos API","version":"2.0.0"},"components":{"schemas":{"AccountAnalytics":{"type":"object","properties":{"screenshots":{"type":"object","properties":{"series":{"type":"array","items":{"type":"object","properties":{"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"projects":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"description":"Counts keyed by project ID. Use the sibling `projects` array to resolve each project name."},"ts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Unix timestamp in milliseconds at the start of the period."}},"required":["total","projects","ts"],"additionalProperties":false}},"all":{"type":"object","properties":{"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"projects":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"description":"Counts keyed by project ID. Use the sibling `projects` array to resolve each project name."}},"required":["total","projects"],"additionalProperties":false},"projects":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9_\\-.]+$"}},"required":["id","name"],"additionalProperties":false}}},"required":["series","all","projects"],"additionalProperties":false},"builds":{"type":"object","properties":{"series":{"type":"array","items":{"type":"object","properties":{"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"projects":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"description":"Counts keyed by project ID. Use the sibling `projects` array to resolve each project name."},"changesDetected":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"noChanges":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"accepted":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"rejected":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Unix timestamp in milliseconds at the start of the period."}},"required":["total","projects","changesDetected","noChanges","accepted","rejected","ts"],"additionalProperties":false}},"all":{"type":"object","properties":{"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"projects":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"description":"Counts keyed by project ID. Use the sibling `projects` array to resolve each project name."},"changesDetected":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"noChanges":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"accepted":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"rejected":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["total","projects","changesDetected","noChanges","accepted","rejected"],"additionalProperties":false},"projects":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9_\\-.]+$"}},"required":["id","name"],"additionalProperties":false}}},"required":["series","all","projects"],"additionalProperties":false}},"required":["screenshots","builds"],"additionalProperties":false}}}}
```

## The Error object

```json
{"openapi":"3.2.0","info":{"title":"Argos API","version":"2.0.0"},"components":{"schemas":{"Error":{"type":"object","properties":{"error":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["error"],"additionalProperties":false,"description":"Error response"}}}}
```

## The PageInfo object

```json
{"openapi":"3.2.0","info":{"title":"Argos API","version":"2.0.0"},"components":{"schemas":{"PageInfo":{"type":"object","properties":{"total":{"type":"number","description":"Total number of items"},"page":{"type":"number","description":"Current page number"},"perPage":{"type":"number","description":"Number of items per page"}},"required":["total","page","perPage"],"additionalProperties":false,"description":"Page information"}}}}
```

## The Project object

```json
{"openapi":"3.2.0","info":{"title":"Argos API","version":"2.0.0"},"components":{"schemas":{"Project":{"type":"object","properties":{"id":{"type":"string"},"account":{"$ref":"#/components/schemas/Account"},"name":{"type":"string","minLength":1},"defaultBaseBranch":{"type":"string"},"hasRemoteContentAccess":{"type":"boolean"}},"required":["id","account","name","defaultBaseBranch","hasRemoteContentAccess"],"additionalProperties":false,"description":"Project"},"Account":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string","minLength":1}},"required":["id","slug"],"additionalProperties":false,"description":"Account"}}}}
```

## The Account object

```json
{"openapi":"3.2.0","info":{"title":"Argos API","version":"2.0.0"},"components":{"schemas":{"Account":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string","minLength":1}},"required":["id","slug"],"additionalProperties":false,"description":"Account"}}}}
```

## The Build object

```json
{"openapi":"3.2.0","info":{"title":"Argos API","version":"2.0.0"},"components":{"schemas":{"Build":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/BuildId"},"number":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"The build number"},"head":{"description":"The head reference of the build","$ref":"#/components/schemas/BuildGitReference"},"base":{"anyOf":[{"$ref":"#/components/schemas/BuildGitReference"},{"type":"null"}],"description":"The base reference of the build"},"status":{"anyOf":[{"type":"string","enum":["accepted","rejected"]},{"type":"string","enum":["no-changes","changes-detected"]},{"type":"string","enum":["expired","pending","progress","error","aborted"]}],"description":"The status of the build"},"conclusion":{"anyOf":[{"type":"string","enum":["no-changes","changes-detected"]},{"type":"null"}],"description":"The conclusion of the build"},"stats":{"anyOf":[{"type":"object","properties":{"added":{"type":"number","description":"Added snapshots"},"removed":{"type":"number","description":"Removed snapshots"},"unchanged":{"type":"number","description":"Unchanged snapshots"},"changed":{"type":"number","description":"Changed snapshots"},"ignored":{"type":"number","description":"Ignored snapshots"},"failure":{"type":"number","description":"Failure screenshots"},"retryFailure":{"type":"number","description":"Retry failure screenshots"},"total":{"type":"number","description":"Total number of snapshots"}},"required":["added","removed","unchanged","changed","ignored","failure","retryFailure","total"],"additionalProperties":false},{"type":"null"}],"description":"Stats of the diffs present in the build"},"metadata":{"anyOf":[{"type":"object","properties":{"testReport":{"description":"Test suite report","type":"object","properties":{"status":{"type":"string","enum":["passed","failed","timedout","interrupted"],"description":"Status of the test suite"},"stats":{"type":"object","properties":{"startTime":{"description":"Date when the test suite started","type":"string"},"duration":{"description":"Duration of the test suite in milliseconds","type":"number"}},"additionalProperties":false}},"required":["status"],"additionalProperties":false}},"additionalProperties":false,"description":"Metadata associated to the build"},{"type":"null"}]},"url":{"type":"string","format":"uri","description":"The URL of the build"},"notification":{"anyOf":[{"type":"object","properties":{"description":{"type":"string"},"context":{"type":"string"},"github":{"type":"object","properties":{"state":{"type":"string","enum":["pending","success","error","failure"]}},"required":["state"],"additionalProperties":false},"gitlab":{"type":"object","properties":{"state":{"type":"string","enum":["pending","running","success","failed","canceled"]}},"required":["state"],"additionalProperties":false},"url":{"type":"string","format":"uri"}},"required":["description","context","github","gitlab","url"],"additionalProperties":false},{"type":"null"}],"description":"The notification payload for the build"}},"required":["id","number","head","base","status","conclusion","stats","metadata","url","notification"],"additionalProperties":false,"description":"Build"},"BuildId":{"type":"string","description":"A unique identifier for the build"},"BuildGitReference":{"type":"object","properties":{"sha":{"description":"The commit SHA","$ref":"#/components/schemas/Sha1Hash"},"branch":{"type":"string","description":"The branch name"}},"required":["sha","branch"],"additionalProperties":false,"description":"Git reference"},"Sha1Hash":{"type":"string","pattern":"^[0-9a-f]{40}$","description":"SHA1 hash"}}}}
```

## The BuildGitReference object

```json
{"openapi":"3.2.0","info":{"title":"Argos API","version":"2.0.0"},"components":{"schemas":{"BuildGitReference":{"type":"object","properties":{"sha":{"description":"The commit SHA","$ref":"#/components/schemas/Sha1Hash"},"branch":{"type":"string","description":"The branch name"}},"required":["sha","branch"],"additionalProperties":false,"description":"Git reference"},"Sha1Hash":{"type":"string","pattern":"^[0-9a-f]{40}$","description":"SHA1 hash"}}}}
```

## The Me object

```json
{"openapi":"3.2.0","info":{"title":"Argos API","version":"2.0.0"},"components":{"schemas":{"Me":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"accounts":{"type":"array","items":{"$ref":"#/components/schemas/MeAccount"},"description":"The accounts this token can access: the personal account and the teams selected when the token was created or authorized."}},"required":["id","slug","name","accounts"],"additionalProperties":false,"description":"The authenticated user."},"MeAccount":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string","description":"Account slug, used as the `owner` in API paths."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"type":"string","enum":["user","team"]}},"required":["id","slug","name","type"],"additionalProperties":false,"description":"An account (personal or team) accessible to the token."}}}}
```

## The MeAccount object

```json
{"openapi":"3.2.0","info":{"title":"Argos API","version":"2.0.0"},"components":{"schemas":{"MeAccount":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string","description":"Account slug, used as the `owner` in API paths."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"type":"string","enum":["user","team"]}},"required":["id","slug","name","type"],"additionalProperties":false,"description":"An account (personal or team) accessible to the token."}}}}
```

## The SnapshotDiff object

```json
{"openapi":"3.2.0","info":{"title":"Argos API","version":"2.0.0"},"components":{"schemas":{"SnapshotDiff":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the snapshot diff"},"name":{"type":"string","description":"Name of the snapshot diff"},"status":{"type":"string","enum":["pending","removed","failure","added","changed","unchanged","retryFailure","ignored"],"description":"Status of the snapshot diff"},"score":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Similarity score between snapshots"},"group":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grouping key for the snapshot diff"},"parentName":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Parent name of the snapshot (usually the story id)"},"url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"URL of the diff image"},"base":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the snapshot"},"name":{"type":"string","description":"Name of the snapshot"},"metadata":{"anyOf":[{"type":"object","properties":{"$schema":{"description":"Ignored. Can be set to get completions, validations and documentation in some editors.","type":"string"},"url":{"description":"The URL of the page that was screenshotted","anyOf":[{"type":"string"},{"type":"null"}]},"previewUrl":{"description":"An URL to an accessible preview of the screenshot","anyOf":[{"type":"string"},{"type":"null"}]},"viewport":{"anyOf":[{"type":"object","properties":{"width":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The width of the viewport"},"height":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The height of the viewport"}},"required":["width","height"],"additionalProperties":false,"description":"The viewport dimensions when the screenshot was taken"},{"type":"null"}]},"colorScheme":{"description":"The color scheme when the screenshot was taken","anyOf":[{"type":"string","enum":["light","dark"]},{"type":"null"}]},"mediaType":{"description":"The media type when the screenshot was taken","anyOf":[{"type":"string","enum":["screen","print"]},{"type":"null"}]},"test":{"anyOf":[{"type":"object","properties":{"id":{"description":"The unique identifier of the test","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string","description":"The title of the test"},"titlePath":{"type":"array","items":{"type":"string"},"description":"The path of titles leading to the test"},"retries":{"description":"The number of retries for the test","anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"retry":{"description":"The current retry count","anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"repeat":{"description":"The repeat count for the test","anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"location":{"description":"The location of the test in the source code","type":"object","properties":{"file":{"type":"string","description":"The located file"},"line":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The line number in the file"},"column":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The column number in the file"}},"required":["file","line","column"],"additionalProperties":false},"annotations":{"description":"Annotations associated to the test","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of annotation"},"description":{"description":"The description of the annotation","type":"string"},"location":{"description":"The location of the annotation in the source code","type":"object","properties":{"file":{"type":"string","description":"The located file"},"line":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The line number in the file"},"column":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The column number in the file"}},"required":["file","line","column"],"additionalProperties":false}},"required":["type"],"additionalProperties":false,"description":"A test annotation"}},"tags":{"description":"Tags associated to the test","type":"array","items":{"type":"string"}}},"required":["title","titlePath"],"additionalProperties":false,"description":"The test that generated the screenshot"},{"type":"null"}]},"browser":{"anyOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the browser"},"version":{"type":"string","description":"The version of the browser"}},"required":["name","version"],"additionalProperties":false,"description":"The browser that generated the screenshot"},{"type":"null"}]},"automationLibrary":{"type":"object","properties":{"name":{"type":"string","description":"The name of the automation library"},"version":{"type":"string","description":"The version of the automation library"}},"required":["name","version"],"additionalProperties":false,"description":"The automation library that generated the screenshot"},"sdk":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Argos SDK"},"version":{"type":"string","description":"The version of the Argos SDK"}},"required":["name","version"],"additionalProperties":false,"description":"The Argos SDK that generated the screenshot"},"story":{"description":"Storybook story metadata","anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the story"},"tags":{"description":"Tags attached to the story","type":"array","items":{"type":"string"}},"mode":{"description":"Story mode","type":"string"},"play":{"description":"True if the story has a play function","type":"boolean"}},"required":["id"],"additionalProperties":false,"description":"Storybook story metadata"},{"type":"null"}]},"tags":{"description":"Tags associated to the screenshot","type":"array","items":{"type":"string"}}},"required":["automationLibrary","sdk"],"additionalProperties":false,"description":"Metadata about a screenshot"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Width of the screenshot in pixels"},"height":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Height of the screenshot in pixels"},"url":{"type":"string","format":"uri","description":"Public URL of the snapshot"},"contentType":{"type":"string","description":"Content type of the snapshot file"}},"required":["id","name","metadata","width","height","url","contentType"],"additionalProperties":false,"description":"Snapshot associated to a diff"},{"type":"null"}]},"head":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the snapshot"},"name":{"type":"string","description":"Name of the snapshot"},"metadata":{"anyOf":[{"type":"object","properties":{"$schema":{"description":"Ignored. Can be set to get completions, validations and documentation in some editors.","type":"string"},"url":{"description":"The URL of the page that was screenshotted","anyOf":[{"type":"string"},{"type":"null"}]},"previewUrl":{"description":"An URL to an accessible preview of the screenshot","anyOf":[{"type":"string"},{"type":"null"}]},"viewport":{"anyOf":[{"type":"object","properties":{"width":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The width of the viewport"},"height":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The height of the viewport"}},"required":["width","height"],"additionalProperties":false,"description":"The viewport dimensions when the screenshot was taken"},{"type":"null"}]},"colorScheme":{"description":"The color scheme when the screenshot was taken","anyOf":[{"type":"string","enum":["light","dark"]},{"type":"null"}]},"mediaType":{"description":"The media type when the screenshot was taken","anyOf":[{"type":"string","enum":["screen","print"]},{"type":"null"}]},"test":{"anyOf":[{"type":"object","properties":{"id":{"description":"The unique identifier of the test","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string","description":"The title of the test"},"titlePath":{"type":"array","items":{"type":"string"},"description":"The path of titles leading to the test"},"retries":{"description":"The number of retries for the test","anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"retry":{"description":"The current retry count","anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"repeat":{"description":"The repeat count for the test","anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"location":{"description":"The location of the test in the source code","type":"object","properties":{"file":{"type":"string","description":"The located file"},"line":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The line number in the file"},"column":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The column number in the file"}},"required":["file","line","column"],"additionalProperties":false},"annotations":{"description":"Annotations associated to the test","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of annotation"},"description":{"description":"The description of the annotation","type":"string"},"location":{"description":"The location of the annotation in the source code","type":"object","properties":{"file":{"type":"string","description":"The located file"},"line":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The line number in the file"},"column":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The column number in the file"}},"required":["file","line","column"],"additionalProperties":false}},"required":["type"],"additionalProperties":false,"description":"A test annotation"}},"tags":{"description":"Tags associated to the test","type":"array","items":{"type":"string"}}},"required":["title","titlePath"],"additionalProperties":false,"description":"The test that generated the screenshot"},{"type":"null"}]},"browser":{"anyOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the browser"},"version":{"type":"string","description":"The version of the browser"}},"required":["name","version"],"additionalProperties":false,"description":"The browser that generated the screenshot"},{"type":"null"}]},"automationLibrary":{"type":"object","properties":{"name":{"type":"string","description":"The name of the automation library"},"version":{"type":"string","description":"The version of the automation library"}},"required":["name","version"],"additionalProperties":false,"description":"The automation library that generated the screenshot"},"sdk":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Argos SDK"},"version":{"type":"string","description":"The version of the Argos SDK"}},"required":["name","version"],"additionalProperties":false,"description":"The Argos SDK that generated the screenshot"},"story":{"description":"Storybook story metadata","anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the story"},"tags":{"description":"Tags attached to the story","type":"array","items":{"type":"string"}},"mode":{"description":"Story mode","type":"string"},"play":{"description":"True if the story has a play function","type":"boolean"}},"required":["id"],"additionalProperties":false,"description":"Storybook story metadata"},{"type":"null"}]},"tags":{"description":"Tags associated to the screenshot","type":"array","items":{"type":"string"}}},"required":["automationLibrary","sdk"],"additionalProperties":false,"description":"Metadata about a screenshot"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Width of the screenshot in pixels"},"height":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Height of the screenshot in pixels"},"url":{"type":"string","format":"uri","description":"Public URL of the snapshot"},"contentType":{"type":"string","description":"Content type of the snapshot file"}},"required":["id","name","metadata","width","height","url","contentType"],"additionalProperties":false,"description":"Snapshot associated to a diff"},{"type":"null"}]},"test":{"anyOf":[{"$ref":"#/components/schemas/Test"},{"type":"null"}]},"change":{"anyOf":[{"$ref":"#/components/schemas/Change"},{"type":"null"}]}},"required":["id","name","status","score","group","parentName","url","base","head","test","change"],"additionalProperties":false,"description":"Snapshot diff"},"Test":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the test"},"name":{"type":"string","description":"Name of the test"},"buildName":{"type":"string","description":"Name of the build the test belongs to"},"metrics":{"$ref":"#/components/schemas/TestMetrics"}},"required":["id","name","buildName","metrics"],"additionalProperties":false,"description":"Test associated to a diff, with flakiness metrics to help decide whether a change is worth reviewing."},"TestMetrics":{"type":"object","properties":{"total":{"type":"number","description":"Number of builds in which this test ran over the metrics period."},"changes":{"type":"number","description":"Number of times the test changed (produced a diff) over the metrics period."},"uniqueChanges":{"type":"number","description":"Number of changes that were seen only once over the metrics period. A high ratio of unique changes is a strong flakiness signal."},"stability":{"type":"number","description":"Ratio of builds without a change, between 0 and 1. `1` means the test never changed."},"consistency":{"type":"number","description":"How consistent the changes are, between 0 and 1. `1` means changes repeat the same way; a low value means changes are erratic."},"flakiness":{"type":"number","description":"Overall flakiness score between 0 and 1, derived from stability and consistency. `0` means stable, `1` means highly flaky."}},"required":["total","changes","uniqueChanges","stability","consistency","flakiness"],"additionalProperties":false,"description":"Flakiness metrics of a test over the requested period."},"Change":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the change (a test + fingerprint pair). Use it with the ignore/unignore endpoints."},"ignored":{"type":"boolean","description":"Whether this change is currently ignored. Ignored changes no longer require review and are automatically approved."},"occurrences":{"type":"number","description":"Number of times this change has been seen over the metrics period. A high count for a recurring change is a strong flakiness signal."}},"required":["id","ignored","occurrences"],"additionalProperties":false,"description":"A test change: a specific visual difference (fingerprint) of a test that can be ignored to silence flaky changes."}}}}
```

## The Test object

```json
{"openapi":"3.2.0","info":{"title":"Argos API","version":"2.0.0"},"components":{"schemas":{"Test":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the test"},"name":{"type":"string","description":"Name of the test"},"buildName":{"type":"string","description":"Name of the build the test belongs to"},"metrics":{"$ref":"#/components/schemas/TestMetrics"}},"required":["id","name","buildName","metrics"],"additionalProperties":false,"description":"Test associated to a diff, with flakiness metrics to help decide whether a change is worth reviewing."},"TestMetrics":{"type":"object","properties":{"total":{"type":"number","description":"Number of builds in which this test ran over the metrics period."},"changes":{"type":"number","description":"Number of times the test changed (produced a diff) over the metrics period."},"uniqueChanges":{"type":"number","description":"Number of changes that were seen only once over the metrics period. A high ratio of unique changes is a strong flakiness signal."},"stability":{"type":"number","description":"Ratio of builds without a change, between 0 and 1. `1` means the test never changed."},"consistency":{"type":"number","description":"How consistent the changes are, between 0 and 1. `1` means changes repeat the same way; a low value means changes are erratic."},"flakiness":{"type":"number","description":"Overall flakiness score between 0 and 1, derived from stability and consistency. `0` means stable, `1` means highly flaky."}},"required":["total","changes","uniqueChanges","stability","consistency","flakiness"],"additionalProperties":false,"description":"Flakiness metrics of a test over the requested period."}}}}
```

## The TestMetrics object

```json
{"openapi":"3.2.0","info":{"title":"Argos API","version":"2.0.0"},"components":{"schemas":{"TestMetrics":{"type":"object","properties":{"total":{"type":"number","description":"Number of builds in which this test ran over the metrics period."},"changes":{"type":"number","description":"Number of times the test changed (produced a diff) over the metrics period."},"uniqueChanges":{"type":"number","description":"Number of changes that were seen only once over the metrics period. A high ratio of unique changes is a strong flakiness signal."},"stability":{"type":"number","description":"Ratio of builds without a change, between 0 and 1. `1` means the test never changed."},"consistency":{"type":"number","description":"How consistent the changes are, between 0 and 1. `1` means changes repeat the same way; a low value means changes are erratic."},"flakiness":{"type":"number","description":"Overall flakiness score between 0 and 1, derived from stability and consistency. `0` means stable, `1` means highly flaky."}},"required":["total","changes","uniqueChanges","stability","consistency","flakiness"],"additionalProperties":false,"description":"Flakiness metrics of a test over the requested period."}}}}
```

## The Change object

```json
{"openapi":"3.2.0","info":{"title":"Argos API","version":"2.0.0"},"components":{"schemas":{"Change":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the change (a test + fingerprint pair). Use it with the ignore/unignore endpoints."},"ignored":{"type":"boolean","description":"Whether this change is currently ignored. Ignored changes no longer require review and are automatically approved."},"occurrences":{"type":"number","description":"Number of times this change has been seen over the metrics period. A high count for a recurring change is a strong flakiness signal."}},"required":["id","ignored","occurrences"],"additionalProperties":false,"description":"A test change: a specific visual difference (fingerprint) of a test that can be ignored to silence flaky changes."}}}}
```

## The BuildReview object

```json
{"openapi":"3.2.0","info":{"title":"Argos API","version":"2.0.0"},"components":{"schemas":{"BuildReview":{"type":"object","properties":{"id":{"type":"string"},"buildId":{"type":"string"},"state":{"type":"string","enum":["approved","rejected","commented","pending"],"description":"State of a build review: approved, rejected, commented (neutral) or pending (an unsubmitted draft)."},"user":{"anyOf":[{"$ref":"#/components/schemas/User"},{"type":"null"}],"description":"The user who submitted the review."},"dismissedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date the review was dismissed, null if not dismissed."},"dismissedBy":{"anyOf":[{"$ref":"#/components/schemas/User"},{"type":"null"}],"description":"The user who dismissed the review, if any."},"date":{"type":"string","description":"Date the review was created."}},"required":["id","buildId","state","user","dismissedAt","dismissedBy","date"],"additionalProperties":false,"description":"Build review"},"User":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","slug","name"],"additionalProperties":false,"description":"A user."}}}}
```

## The User object

```json
{"openapi":"3.2.0","info":{"title":"Argos API","version":"2.0.0"},"components":{"schemas":{"User":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","slug","name"],"additionalProperties":false,"description":"A user."}}}}
```

## The Comment object

```json
{"openapi":"3.2.0","info":{"title":"Argos API","version":"2.0.0"},"components":{"schemas":{"Comment":{"type":"object","properties":{"id":{"type":"string"},"buildId":{"type":"string"},"threadId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Root comment ID when this comment is a reply."},"body":{"description":"Rich-text JSON content of the comment."},"text":{"type":"string","description":"Plain-text rendering of the comment content."},"author":{"anyOf":[{"$ref":"#/components/schemas/User"},{"type":"null"}]},"screenshotDiffId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Screenshot diff this comment is anchored to, if any."},"anchor":{"anyOf":[{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"point"},"x":{"type":"number"},"y":{"type":"number"}},"required":["type","x","y"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"lines"},"from":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"to":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","from","to"],"additionalProperties":false}],"description":"Where on the referenced screenshot diff the comment points. A point uses normalized (0–1) coordinates; lines is a 1-based inclusive range.","type":"object"},{"type":"null"}],"description":"Where the comment points on its screenshot diff. Null means the whole diff."},"pending":{"type":"boolean","description":"Whether the comment belongs to a pending (unsubmitted) review and is only visible to its author."},"resolvedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date the thread was resolved, null if not resolved. Only set on a root comment."},"editedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date the comment was last edited, null if never edited."},"createdAt":{"type":"string","description":"Date the comment was posted."},"reactions":{"type":"array","items":{"type":"object","properties":{"emoji":{"type":"string","description":"The emoji used for the reaction."},"count":{"type":"number","description":"Number of users who reacted with this emoji."},"users":{"type":"array","items":{"$ref":"#/components/schemas/User"},"description":"The users who reacted with this emoji."}},"required":["emoji","count","users"],"additionalProperties":false,"description":"Reactions of a single emoji on a comment."}}},"required":["id","buildId","threadId","body","text","author","screenshotDiffId","anchor","pending","resolvedAt","editedAt","createdAt","reactions"],"additionalProperties":false,"description":"A comment posted on a build."},"User":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","slug","name"],"additionalProperties":false,"description":"A user."}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://argos-ci.com/docs/api-reference/reference/models.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.