> For the complete documentation index, see [llms.txt](https://docs.sealights.io/knowledgebase/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sealights.io/knowledgebase/setup-and-configuration/integrations/rest-apis/sl-public-api.md).

# SeaLights Public APIs

Programmatic access to SeaLights data, builds, coverage, test sessions, reports, and TIA recommendations.

The SeaLights Public API is a RESTful API that gives you direct access to the same data and actions available in the SeaLights dashboard — from your own tooling, CI/CD pipelines, and scripts.

## What you can do

| Area                        | Endpoints                                                                 | Examples                                                                                                    |
| --------------------------- | ------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| **Agents**                  | `agents`, `agent-apis`                                                    | Query live agents, get default agent version, create lab IDs and integration builds                         |
| **Apps & branches**         | `apps`                                                                    | List apps and branches, check branch existence, enable/disable apps and branches                            |
| **Audit**                   | `audit-logs`, `audit-log-actions`                                         | Retrieve audit log entries and available action types                                                       |
| **Batch tasks**             | `batch`                                                                   | Submit asynchronous batch operations and download results                                                   |
| **Builds**                  | `builds`                                                                  | Query build details, quality status, tag builds, set reference builds                                       |
| **Code configuration**      | `code-domains`, `code-labels`, `settings`                                 | Manage code domains, code label rules, code scope rules, and ignore rules                                   |
| **Coverage**                | `coverage`, `code-to-test`, `integration-builds`                          | Read coverage data by build, export CSVs, manage integration build components                               |
| **Labs**                    | `lab-ids`, `live-labs`                                                    | Query lab IDs and live lab component status                                                                 |
| **Reports**                 | `tga`, `custom-reports`, `quality-analytics`, `multi-app-coverage-report` | Generate and download TGA reports, custom reports, trend report URLs, multi-app coverage reports            |
| **Test execution**          | `tests`, `executions`, `slim-builds`                                      | Query test run results by build or branch, retrieve execution data                                          |
| **Test Intelligence (TIA)** | `tia`, `test-sessions`, `model`                                           | Open and close test sessions, get TIA recommendations, control full-run flags, calibrate statistical models |

## In this section

| Page                                                                                                                                                    | What it covers                                              |
| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- |
| [Get started](https://docs.sealights.io/knowledgebase/setup-and-configuration/integrations/rest-apis/sl-public-api/get-started.md)                      | Base URL, first request, and quick-start checklist          |
| [Authorization](https://docs.sealights.io/knowledgebase/setup-and-configuration/integrations/rest-apis/sl-public-api/authorization.md)                  | API Token vs Agent Token — which to use and how to get each |
| [Request and response format](https://github.com/Sealights/gitbook.setupandconfiguration/tree/master/integrations/rest-apis/request-response-format.md) | Response envelope, status codes, pagination, rate limiting  |
| [API reference](https://docs.sealights.io/knowledgebase/setup-and-configuration/integrations/rest-apis/sl-public-api/api-reference.md)                  | All 84 active endpoints in alphabetical order               |


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.sealights.io/knowledgebase/setup-and-configuration/integrations/rest-apis/sl-public-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
