How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Checkly

Checkly Test sessions API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Checkly Test sessions API is one of 42 APIs that Checkly publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Test sessions. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 7 paths, and defines 21 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.checklyhq.com.

7 operations 7 paths 21 schemas 5 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.checklyhq.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Checkly Test sessions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Bearer) (Bearer). By default, every request must be authenticated.

  • Bearer — The Checkly Public API uses API keys to authenticate requests. You can get the API Key here . Your API key is like a password: keep it secure! Authentication t…

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 5 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Test sessions 7
GET
/v1/test-sessions
List test sessions
getV1Testsessions 12 params → 200400401402403429
POST
/v1/test-sessions/trigger
Trigger a new test session
postV1TestsessionsTrigger 1 param body → 201400401402403404429
GET
/v1/test-sessions/{testSessionId}
Retrieve a test session
getV1TestsessionsTestsessionid 2 params → 200400401403404429
POST
/v1/test-sessions/{testSessionId}/cancel
Cancel a test session
postV1TestsessionsTestsessionidCancel 2 params body → 204400401403404429
GET
/v1/test-sessions/{testSessionId}/completion
Await the completion of a test session
getV1TestsessionsTestsessionidCompletion 3 params → 200400401403404408429
GET
/v1/test-sessions/{testSessionId}/results/{testSessionResultId}
Retrieve a test session result
getV1TestsessionsTestsessionidResultsTestsessionresultid 3 params → 200400401403404429
GET
/v1/test-sessions/{testSessionId}/results/{testSessionResultId}/assets
Retrieve a normalized asset manifest for a test-session result
getV1TestsessionsTestsessionidResultsTestsessionresultidAssets 5 params → 200400401403404429

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are FindOneTestSessionResultResponse (32 properties), TestSessionListEntry (24 properties), TestSessionResult (16 properties), TestSessionBrowserResultDetails (13 properties). Each schema is shown below with its type and property counts.

TestSessionEnvironmentVariable
TestSessionApiResultDetails
objectnull
7 properties
TestSessionListEntryInvoker
objectnull
2 properties 1 required
TestSessionGitHubMetadata
object
12 properties 1 required
ListTestSessionsResponse
object
3 properties 2 required
TestSessionMetadata
object
7 properties
TestSessionResult
object
16 properties 9 required
ApiError
object
3 properties 3 required
TestSessionBrowserResultDetails
objectnull
13 properties
TriggerTestSessionResponse
object
10 properties 7 required
AssetManifestEntry
object
6 properties 4 required
TestSessionsV1CancelRequest
object
1 property
TestSessionAgenticResultDetails
objectnull
10 properties
TestSessionMultiStepResultDetails
objectnull
10 properties
AssetManifest
object
4 properties 1 required
TriggerTestSessionRequest
object
7 properties 2 required
FindOneTestSessionResultResponse
object
32 properties 15 required
TestSessionPlaywrightResultDetails
objectnull
8 properties
FindOneTestSessionResponse
object
10 properties 7 required
TestSessionListEntry
object
24 properties 7 required
AwaitTestSessionCompletionResponse
object
10 properties 8 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

checkly-test-sessions-api-openapi.yml Raw ↑

Other APIs Checkly publishes across the network.

Checkly
AE Profile APIs.io
Checkly Accounts API
AE Profile APIs.io
Checkly Alert Channels API
AE Profile APIs.io
Checkly Analytics API
AE Profile APIs.io
Checkly Check Alerts API
AE Profile APIs.io
Checkly Check Groups API
AE Profile APIs.io
Checkly Check Results API
AE Profile APIs.io
Checkly Checks API
AE Profile APIs.io
Checkly Dashboards API
AE Profile APIs.io
Checkly Heartbeats API
AE Profile APIs.io
Checkly Incidents API
AE Profile APIs.io
Checkly Maintenance Windows API
AE Profile APIs.io
#Test sessions
← Back to C APIs
API Details
ID
checkly:checkly-test-sessions-api
Base URL
https://api.checklyhq.com
Docs
https://www.checklyhq.com
Provider
Checkly
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=checkly-test-sessions-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/checkly-test-sessions-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Checkly Test sessions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.