Skip to content
Read API

Overview

The Squally read API gives your scripts, CI jobs and AI agents the same test results you see in the app: runs, per-test metrics and error groups.

Create a read key

As an organization admin, open Organization › Read keys and create a read key. It starts with sqly_ro_ and is shown once.

Copy a project ID

Each project’s ID, with a copy button, is in Project settings › General.

Call the API

curl "https://app.squally.dev/api/v1/projects" \
-H "Authorization: Bearer $SQUALLY_API_KEY"

v1, beta. The API may change until the beta ends; every change is listed in the changelog (docs/openapi/CHANGELOG.md).

Every change is listed in the API changelog.