# Suite runs

Executing and getting result

## Retrieving suite run list

> Returns many suite runs.

```json
{"openapi":"3.1.0","info":{"title":"BugBug.io Public API","version":"v2"},"tags":[{"name":"Suite runs","description":"Executing and getting result"}],"security":[{"tokenAuth":[]},{"Bearer":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"PaginatedV2SuiteRunList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/V2SuiteRun"}}}},"V2SuiteRun":{"type":"object","properties":{"duration":{"type":["string","null"],"readOnly":true},"ended":{"type":["string","null"],"format":"date-time","readOnly":true},"errorCode":{"type":["string","null"],"readOnly":true},"id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":"string","readOnly":true},"parallelRun":{"type":["boolean","null"],"readOnly":true},"parallelSlots":{"type":["integer","null"],"readOnly":true,"title":"Max possible slots for parallel run"},"profileId":{"type":"string","format":"uuid","readOnly":true},"profileName":{"type":"string","readOnly":true},"queued":{"type":["string","null"],"format":"date-time","readOnly":true},"runMode":{"enum":["server","local","recording"],"type":"string","description":"* `server` - cloud\n* `local` - local\n* `recording` - recording","readOnly":true},"sequence":{"type":["integer","null"],"readOnly":true},"started":{"type":["string","null"],"format":"date-time","readOnly":true},"status":{"enum":["error","passed","failed","running","auto_retrying","stopped","queued","paused","skipped","recording","initialized"],"type":"string","description":"* `error` - Error\n* `passed` - Passed\n* `failed` - Failed\n* `running` - Running\n* `auto_retrying` - Auto Retrying\n* `stopped` - Stopped\n* `queued` - Queued\n* `paused` - Paused\n* `skipped` - Skipped\n* `recording` - Recording\n* `initialized` - Initialized","readOnly":true},"suiteId":{"type":["string","null"],"format":"uuid","readOnly":true},"testRuns":{"type":"array","items":{"$ref":"#/components/schemas/V2TestRun"},"readOnly":true},"triggeredBy":{"type":"string","readOnly":true},"userId":{"type":["string","null"],"readOnly":true},"webappUrl":{"type":"string","readOnly":true}},"required":["duration","ended","errorCode","id","name","parallelRun","parallelSlots","profileId","profileName","queued","runMode","sequence","started","status","suiteId","testRuns","triggeredBy","userId","webappUrl"]},"V2TestRun":{"type":"object","properties":{"browserName":{"type":["string","null"],"readOnly":true},"browserVersion":{"type":["string","null"],"readOnly":true},"browserHeight":{"type":["integer","null"],"readOnly":true},"browserWidth":{"type":["integer","null"],"readOnly":true},"stepsRuns":{"type":"string","readOnly":true},"userId":{"type":["string","null"],"format":"uuid","readOnly":true},"duration":{"type":["string","null"],"readOnly":true},"ended":{"type":["string","null"],"format":"date-time","readOnly":true},"errorCode":{"type":["string","null"],"readOnly":true},"extensionVersion":{"type":["string","null"],"readOnly":true},"id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":"string","readOnly":true},"osName":{"type":["string","null"],"readOnly":true},"queued":{"type":["string","null"],"format":"date-time","readOnly":true},"runMode":{"enum":["server","local","recording"],"type":"string","description":"* `server` - cloud\n* `local` - local\n* `recording` - recording","readOnly":true},"runProfileId":{"type":["string","null"],"format":"uuid","readOnly":true},"screenSizeType":{"enum":["desktop","mobile","custom"],"type":"string","description":"* `desktop` - Desktop\n* `mobile` - Mobile\n* `custom` - Custom","readOnly":true},"sequence":{"type":["integer","null"],"readOnly":true},"started":{"type":["string","null"],"format":"date-time","readOnly":true},"status":{"enum":["error","passed","failed","running","auto_retrying","stopped","queued","paused","skipped","recording","initialized"],"type":"string","description":"* `error` - Error\n* `passed` - Passed\n* `failed` - Failed\n* `running` - Running\n* `auto_retrying` - Auto Retrying\n* `stopped` - Stopped\n* `queued` - Queued\n* `paused` - Paused\n* `skipped` - Skipped\n* `recording` - Recording\n* `initialized` - Initialized","readOnly":true},"suiteRunId":{"type":["string","null"],"format":"uuid","readOnly":true},"testId":{"type":["string","null"],"format":"uuid","readOnly":true},"triggeredBy":{"enum":["user","api","webhook","scheduler","github","cli","agent"],"type":"string","description":"* `user` - User\n* `api` - Api\n* `webhook` - Webhook\n* `scheduler` - Scheduler\n* `github` - Github\n* `cli` - Cli\n* `agent` - Agent","readOnly":true},"webappUrl":{"type":"string","readOnly":true}},"required":["browserHeight","browserName","browserVersion","browserWidth","duration","ended","errorCode","extensionVersion","id","name","osName","queued","runMode","runProfileId","screenSizeType","sequence","started","status","stepsRuns","suiteRunId","testId","triggeredBy","userId","webappUrl"]}}},"paths":{"/api/v2/suiteruns/":{"get":{"operationId":"v2_suiteruns_list","description":"Returns many suite runs.","summary":"Retrieving suite run list","parameters":[{"name":"ordering","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"name":"page","required":false,"in":"query","description":"A page number within the paginated result set.","schema":{"type":"integer"}},{"name":"page_size","required":false,"in":"query","description":"Number of results to return per page.","schema":{"type":"integer"}},{"in":"query","name":"started_after","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"started_before","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"suiteId","schema":{"type":"string"},"description":"Filter list by suite ID."}],"tags":["Suite runs"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedV2SuiteRunList"}}},"description":""},"401":{"description":"Authentication credentials were missing or invalid."}}}}}}
```

## Execute desired suite

> Execute desired suite.

```json
{"openapi":"3.1.0","info":{"title":"BugBug.io Public API","version":"v2"},"tags":[{"name":"Suite runs","description":"Executing and getting result"}],"security":[{"tokenAuth":[]},{"Bearer":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"V2RunSuite":{"type":"object","properties":{"suiteId":{"type":"string","format":"uuid"},"runProfileId":{"type":["string","null"],"format":"uuid"},"variables":{"type":["array","null"],"items":{"$ref":"#/components/schemas/V2OverrideVariable"},"default":[]}},"required":["suiteId"]},"V2OverrideVariable":{"type":"object","properties":{"key":{"type":"string","maxLength":128},"value":{"type":["string","null"]}},"required":["key"]},"V2SuiteRunStatus":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"status":{"enum":["error","passed","failed","running","auto_retrying","stopped","queued","paused","skipped","recording","initialized"],"type":"string","description":"* `error` - Error\n* `passed` - Passed\n* `failed` - Failed\n* `running` - Running\n* `auto_retrying` - Auto Retrying\n* `stopped` - Stopped\n* `queued` - Queued\n* `paused` - Paused\n* `skipped` - Skipped\n* `recording` - Recording\n* `initialized` - Initialized","readOnly":true},"finishedTests":{"type":"integer","readOnly":true},"totalTests":{"type":"integer","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true},"webappUrl":{"type":"string","readOnly":true}},"required":["finishedTests","id","modified","status","totalTests","webappUrl"]}}},"paths":{"/api/v2/suiteruns/":{"post":{"operationId":"v2_suiteruns_create","description":"Execute desired suite.","summary":"Execute desired suite","tags":["Suite runs"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2RunSuite"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2SuiteRunStatus"}}},"description":""},"400":{"description":"Request body failed validation."},"401":{"description":"Authentication credentials were missing or invalid."}}}}}}
```

## Retrieve suite run result

> Returns single object.

```json
{"openapi":"3.1.0","info":{"title":"BugBug.io Public API","version":"v2"},"tags":[{"name":"Suite runs","description":"Executing and getting result"}],"security":[{"tokenAuth":[]},{"Bearer":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"V2SuiteRun":{"type":"object","properties":{"duration":{"type":["string","null"],"readOnly":true},"ended":{"type":["string","null"],"format":"date-time","readOnly":true},"errorCode":{"type":["string","null"],"readOnly":true},"id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":"string","readOnly":true},"parallelRun":{"type":["boolean","null"],"readOnly":true},"parallelSlots":{"type":["integer","null"],"readOnly":true,"title":"Max possible slots for parallel run"},"profileId":{"type":"string","format":"uuid","readOnly":true},"profileName":{"type":"string","readOnly":true},"queued":{"type":["string","null"],"format":"date-time","readOnly":true},"runMode":{"enum":["server","local","recording"],"type":"string","description":"* `server` - cloud\n* `local` - local\n* `recording` - recording","readOnly":true},"sequence":{"type":["integer","null"],"readOnly":true},"started":{"type":["string","null"],"format":"date-time","readOnly":true},"status":{"enum":["error","passed","failed","running","auto_retrying","stopped","queued","paused","skipped","recording","initialized"],"type":"string","description":"* `error` - Error\n* `passed` - Passed\n* `failed` - Failed\n* `running` - Running\n* `auto_retrying` - Auto Retrying\n* `stopped` - Stopped\n* `queued` - Queued\n* `paused` - Paused\n* `skipped` - Skipped\n* `recording` - Recording\n* `initialized` - Initialized","readOnly":true},"suiteId":{"type":["string","null"],"format":"uuid","readOnly":true},"testRuns":{"type":"array","items":{"$ref":"#/components/schemas/V2TestRun"},"readOnly":true},"triggeredBy":{"type":"string","readOnly":true},"userId":{"type":["string","null"],"readOnly":true},"webappUrl":{"type":"string","readOnly":true}},"required":["duration","ended","errorCode","id","name","parallelRun","parallelSlots","profileId","profileName","queued","runMode","sequence","started","status","suiteId","testRuns","triggeredBy","userId","webappUrl"]},"V2TestRun":{"type":"object","properties":{"browserName":{"type":["string","null"],"readOnly":true},"browserVersion":{"type":["string","null"],"readOnly":true},"browserHeight":{"type":["integer","null"],"readOnly":true},"browserWidth":{"type":["integer","null"],"readOnly":true},"stepsRuns":{"type":"string","readOnly":true},"userId":{"type":["string","null"],"format":"uuid","readOnly":true},"duration":{"type":["string","null"],"readOnly":true},"ended":{"type":["string","null"],"format":"date-time","readOnly":true},"errorCode":{"type":["string","null"],"readOnly":true},"extensionVersion":{"type":["string","null"],"readOnly":true},"id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":"string","readOnly":true},"osName":{"type":["string","null"],"readOnly":true},"queued":{"type":["string","null"],"format":"date-time","readOnly":true},"runMode":{"enum":["server","local","recording"],"type":"string","description":"* `server` - cloud\n* `local` - local\n* `recording` - recording","readOnly":true},"runProfileId":{"type":["string","null"],"format":"uuid","readOnly":true},"screenSizeType":{"enum":["desktop","mobile","custom"],"type":"string","description":"* `desktop` - Desktop\n* `mobile` - Mobile\n* `custom` - Custom","readOnly":true},"sequence":{"type":["integer","null"],"readOnly":true},"started":{"type":["string","null"],"format":"date-time","readOnly":true},"status":{"enum":["error","passed","failed","running","auto_retrying","stopped","queued","paused","skipped","recording","initialized"],"type":"string","description":"* `error` - Error\n* `passed` - Passed\n* `failed` - Failed\n* `running` - Running\n* `auto_retrying` - Auto Retrying\n* `stopped` - Stopped\n* `queued` - Queued\n* `paused` - Paused\n* `skipped` - Skipped\n* `recording` - Recording\n* `initialized` - Initialized","readOnly":true},"suiteRunId":{"type":["string","null"],"format":"uuid","readOnly":true},"testId":{"type":["string","null"],"format":"uuid","readOnly":true},"triggeredBy":{"enum":["user","api","webhook","scheduler","github","cli","agent"],"type":"string","description":"* `user` - User\n* `api` - Api\n* `webhook` - Webhook\n* `scheduler` - Scheduler\n* `github` - Github\n* `cli` - Cli\n* `agent` - Agent","readOnly":true},"webappUrl":{"type":"string","readOnly":true}},"required":["browserHeight","browserName","browserVersion","browserWidth","duration","ended","errorCode","extensionVersion","id","name","osName","queued","runMode","runProfileId","screenSizeType","sequence","started","status","stepsRuns","suiteRunId","testId","triggeredBy","userId","webappUrl"]}}},"paths":{"/api/v2/suiteruns/{id}/":{"get":{"operationId":"v2_suiteruns_retrieve","description":"Returns single object.","summary":"Retrieve suite run result","parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"description":"A UUID string identifying this suite run.","required":true}],"tags":["Suite runs"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2SuiteRun"}}},"description":""},"401":{"description":"Authentication credentials were missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## Download report

> Download the report for the selected suite run in the specified format.

```json
{"openapi":"3.1.0","info":{"title":"BugBug.io Public API","version":"v2"},"tags":[{"name":"Suite runs","description":"Executing and getting result"}],"security":[{"tokenAuth":[]},{"Bearer":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}}},"paths":{"/api/v2/suiteruns/{id}/report/junit/":{"get":{"operationId":"v2_suiteruns_report_junit_retrieve","description":"Download the report for the selected suite run in the specified format.","summary":"Download report","parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"description":"A UUID string identifying this suite run.","required":true}],"tags":["Suite runs"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string","format":"binary"}}},"description":"JUnit XML report file"},"401":{"description":"Authentication credentials were missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## Get suite run steps screenshots

> Returns all screenshots.

```json
{"openapi":"3.1.0","info":{"title":"BugBug.io Public API","version":"v2"},"tags":[{"name":"Suite runs","description":"Executing and getting result"}],"security":[{"tokenAuth":[]},{"Bearer":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"V2SuiteRunScreenshots":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"testsRuns":{"type":"array","items":{"$ref":"#/components/schemas/V2TestRunScreenshots"},"readOnly":true}},"required":["id","testsRuns"]},"V2TestRunScreenshots":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"stepsRuns":{"type":"array","items":{"$ref":"#/components/schemas/V2StepRunScreenshot"},"readOnly":true}},"required":["id","stepsRuns"]},"V2StepRunScreenshot":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"stepId":{"type":["string","null"],"format":"uuid","readOnly":true},"screenshotUrl":{"type":"string"}},"required":["id","screenshotUrl","stepId"]}}},"paths":{"/api/v2/suiteruns/{id}/screenshots/":{"get":{"operationId":"v2_suiteruns_screenshots_retrieve","description":"Returns all screenshots.","summary":"Get suite run steps screenshots","parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"description":"A UUID string identifying this suite run.","required":true}],"tags":["Suite runs"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2SuiteRunScreenshots"}}},"description":""},"401":{"description":"Authentication credentials were missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## Get suite run status

> Returns single object.

```json
{"openapi":"3.1.0","info":{"title":"BugBug.io Public API","version":"v2"},"tags":[{"name":"Suite runs","description":"Executing and getting result"}],"security":[{"tokenAuth":[]},{"Bearer":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"V2SuiteRunStatus":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"status":{"enum":["error","passed","failed","running","auto_retrying","stopped","queued","paused","skipped","recording","initialized"],"type":"string","description":"* `error` - Error\n* `passed` - Passed\n* `failed` - Failed\n* `running` - Running\n* `auto_retrying` - Auto Retrying\n* `stopped` - Stopped\n* `queued` - Queued\n* `paused` - Paused\n* `skipped` - Skipped\n* `recording` - Recording\n* `initialized` - Initialized","readOnly":true},"finishedTests":{"type":"integer","readOnly":true},"totalTests":{"type":"integer","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true},"webappUrl":{"type":"string","readOnly":true}},"required":["finishedTests","id","modified","status","totalTests","webappUrl"]}}},"paths":{"/api/v2/suiteruns/{id}/status/":{"get":{"operationId":"v2_suiteruns_status_retrieve","description":"Returns single object.","summary":"Get suite run status","parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"description":"A UUID string identifying this suite run.","required":true}],"tags":["Suite runs"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2SuiteRunStatus"}}},"description":""},"401":{"description":"Authentication credentials were missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## Stop running suite run.

> Stop suite run.

```json
{"openapi":"3.1.0","info":{"title":"BugBug.io Public API","version":"v2"},"tags":[{"name":"Suite runs","description":"Executing and getting result"}],"security":[{"tokenAuth":[]},{"Bearer":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"V2SuiteRunStatus":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"status":{"enum":["error","passed","failed","running","auto_retrying","stopped","queued","paused","skipped","recording","initialized"],"type":"string","description":"* `error` - Error\n* `passed` - Passed\n* `failed` - Failed\n* `running` - Running\n* `auto_retrying` - Auto Retrying\n* `stopped` - Stopped\n* `queued` - Queued\n* `paused` - Paused\n* `skipped` - Skipped\n* `recording` - Recording\n* `initialized` - Initialized","readOnly":true},"finishedTests":{"type":"integer","readOnly":true},"totalTests":{"type":"integer","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true},"webappUrl":{"type":"string","readOnly":true}},"required":["finishedTests","id","modified","status","totalTests","webappUrl"]}}},"paths":{"/api/v2/suiteruns/{id}/stop/":{"post":{"operationId":"v2_suiteruns_stop_create","description":"Stop suite run.","summary":"Stop running suite run.","parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"description":"A UUID string identifying this suite run.","required":true}],"tags":["Suite runs"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2SuiteRunStatus"}}},"description":""},"400":{"description":"Request body failed validation."},"401":{"description":"Authentication credentials were missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```


---

# Agent Instructions: 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:

```
GET https://docs.bugbug.io/public-api-reference/suite-runs.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.