Skip to main content
GET
/
nyx
/
runs
/
{run_id}
/
report
Get Report
curl --request GET \
  --url https://api.example.com/nyx/runs/{run_id}/report

Overview

Returns the full audit report as markdown. The report includes findings, reproduction steps, and the attack chain Nyx used to surface each vulnerability.
Only available once a run reaches status: "completed". Calling it earlier returns 425 Too Early.

Path Parameters

run_id
string
required
The run_id returned by POST /nyx/runs.

Headers

Accept
string
Use text/markdown to receive the report body. Defaults to text/markdown if omitted.

Response

A text/markdown body containing the audit report. The CLI writes it to <output>/<config_name>-report.md.

Example

curl https://api.fabraix.com/v1/nyx/runs/r_01H2X3Y4Z5/report \
  -H "X-Verification-Token: $NYX_TOKEN" \
  -H "Accept: text/markdown" \
  -o playground-report.md

Errors

StatusMeaning
401Invalid or expired X-Verification-Token
404run_id not found
425Run is still in progress, report not ready yet