Get Report
curl --request GET \
--url https://api.example.com/nyx/runs/{run_id}/reportimport requests
url = "https://api.example.com/nyx/runs/{run_id}/report"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/nyx/runs/{run_id}/report', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/nyx/runs/{run_id}/report",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/nyx/runs/{run_id}/report"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/nyx/runs/{run_id}/report")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/nyx/runs/{run_id}/report")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyNyx Endpoints
Get Report
Download the full markdown audit report for a completed Nyx run
GET
/
nyx
/
runs
/
{run_id}
/
report
Get Report
curl --request GET \
--url https://api.example.com/nyx/runs/{run_id}/reportimport requests
url = "https://api.example.com/nyx/runs/{run_id}/report"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/nyx/runs/{run_id}/report', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/nyx/runs/{run_id}/report",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/nyx/runs/{run_id}/report"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/nyx/runs/{run_id}/report")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/nyx/runs/{run_id}/report")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyOverview
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
string
required
The
run_id returned by POST /nyx/runs.Headers
string
Use
text/markdown to receive the report body. Defaults to text/markdown if omitted.Response
Atext/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
import { writeFile } from 'node:fs/promises';
const res = await fetch(
`https://api.fabraix.com/v1/nyx/runs/${runId}/report`,
{
headers: {
'X-Verification-Token': process.env.NYX_TOKEN,
Accept: 'text/markdown',
},
}
);
if (res.status === 425) {
console.error('Run still in progress, try again once it completes.');
process.exit(1);
}
await writeFile('playground-report.md', await res.text());
Errors
| Status | Meaning |
|---|---|
| 401 | Invalid or expired X-Verification-Token |
| 404 | run_id not found |
| 425 | Run is still in progress, report not ready yet |
Related Endpoints
- POST /nyx/runs: submit a new run
- GET /nyx/runs/: poll for completion
Was this page helpful?