Checkly

Checkly Test sessions API

The Test sessions API from Checkly — 7 operation(s) for test sessions.

GitHub OpenAPI

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/test-sessions List test sessions · List test sessions #
Ask an LLM
“Which test sessions ran recently in my account?”
“Can I filter test sessions by branch, status or who ran them?”
Tell an agent
List my test sessions.
Show test sessions on branch {branches} with status {statuses} since {from}.
POST /v1/test-sessions/trigger Start a test session · Trigger a new test session #
Ask an LLM
“How do I launch a test session against my checks with extra environment variables?”
“Can I attach metadata when starting a test session?”
Tell an agent
Run test session {name} in {runLocation}.
Launch test session {name} from {runLocation} with environment variables {environmentVariables}.
GET /v1/test-sessions/{testSessionId} Get a test session · Retrieve a test session #
Ask an LLM
“What's the current state and results of a test session?”
“Can I look at a test session that is still in progress?”
Tell an agent
Show test session {testSessionId}.
Get the details of test session {testSessionId}.
POST /v1/test-sessions/{testSessionId}/cancel Cancel a running test session · Cancel a test session #
Ask an LLM
“How do I stop a test session that's still running?”
“Can I cancel only certain results within a test session?”
Tell an agent destructive · confirm first
Cancel test session {testSessionId}.
Cancel the runs {sequenceId} in test session {testSessionId}.
GET /v1/test-sessions/{testSessionId}/completion Wait for a test session to finish · Await the completion of a test session #
Ask an LLM
“Can I block until a test session passes or fails?”
“What happens if a test session takes longer than my wait time?”
Tell an agent
Wait for test session {testSessionId} to complete.
Wait up to {maxWaitSeconds} seconds for test session {testSessionId} to finish.
GET /v1/test-sessions/{testSessionId}/results/{testSessionResultId} Get one result from a test session · Retrieve a test session result #
Ask an LLM
“What are the details of a single result inside a test session?”
“Does a test session result include references to uploaded assets?”
Tell an agent
Show result {testSessionResultId} of test session {testSessionId}.
Get the detailed data for test session {testSessionId} result {testSessionResultId}.
GET /v1/test-sessions/{testSessionId}/results/{testSessionResultId}/assets List downloadable assets of a test session result · Retrieve a normalized asset manifest for a test-session result #
Ask an LLM
“Where can I download the traces, screenshots or videos from a test session result?”
“Can I filter a test session result's assets by type?”
Tell an agent
List assets for result {testSessionResultId} in test session {testSessionId}.
Show {type} assets of test session {testSessionId} result {testSessionResultId}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/checkly/refs/heads/main/openapi/checkly-test-sessions-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/checkly:checkly-test-sessions-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

checkly-test-sessions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Checkly Public Test sessions API
  version: v1
  description: 'These are the docs for the newly released Checkly Public API.

    If you have any questions, please do not hesitate to get in touch with us.'
servers:
- url: https://api.checklyhq.com
security:
- Bearer: []
tags:


# --- truncated at 32 KB (49 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/checkly/refs/heads/main/openapi/checkly-test-sessions-api-openapi.yml