Skip to main content
GET
Get debugging context for a run, suite, or test case
This endpoint returns debugging context for a run, suite, or test case.

Quick Reference

Pick the context level

At least 1 of runId, suiteId, or caseId is required.
If multiple IDs are passed, the most-specific level wins.

Parent ID rules

  • suiteId requires runId. The API returns 400 if suiteId is passed without runId.
  • caseId can be sent without runId. The service resolves the latest run for that case and returns it in data.meta.runId.

Response formats and detail modes

  • format=json returns the standard envelope with data.level.
  • format=md returns a plain Markdown response for AI prompts.
  • detail=summary removes steps[] at test level.
  • detail=compact removes steps[], stdout, and stderr, and caps assets.* arrays at 5 with totals.
Each level includes links.uiUrl and links.retryCommand.
Test-level responses also include links.traceViewerUrl, or null when trace data is unavailable.

Authorizations

Authorization
string
header
required

User PAT (td_pat_) scoped to the target project

Path Parameters

projectId
string
required

The project identifier (e.g. project_abc123). Must match the project associated with your PAT.

Query Parameters

runId
string

Run ID. Required for run level and required with suiteId.

suiteId
string

Suite ID. Requires runId.

caseId
string

Test case ID. runId is optional.

attempt
integer

Zero-indexed attempt number (test level only).

Required range: x >= 0
format
enum<string>
default:json

Response format: json (default) or md.

Available options:
json,
md
detail
enum<string>
default:default

Payload size mode: default, summary, or compact.

Available options:
default,
compact,
summary
page
integer
default:1

Pagination (run + suite levels only).

Required range: x >= 1
limit
integer
default:10

Pagination size for run/suite levels.

Required range: 1 <= x <= 50
maxLength
integer

Maximum Markdown length when format=md.

Required range: 1 <= x <= 50000

Response

Context payload. Shape depends on data.level (run, suite, test).

success
boolean
data
object

Shape varies by level. See description for per-level fields.