Retrieve a tool run

Read state, native result, output references, coverage and cleanup status.

View as Markdown ↗

GET/v1/tool-runs/{run_id}

Check whether your tool finished

GET the run ID from submission. While it is not terminal, wait briefly and poll again.

What to do next

At completion, inspect state, result.exit_code, cleanup_status and the outputs list.

Read the step-by-step guide →

Parameter and response reference

Parameters

run_idpath · stringrequired

authorizationheader · string | nullrequired

Responses

200 Successful Response
422 Validation Error

Copyable examples · your API endpoint

Request

curl -X GET "$SECURITY_RUN_URL/v1/tool-runs/toolrun_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
  -H "Authorization: Bearer $SECURITY_RUN_API_KEY"

Request

import os, httpx

headers = {}
headers["Authorization"] = "Bearer " + os.environ["SECURITY_RUN_API_KEY"]
response = httpx.request('GET', os.environ["SECURITY_RUN_URL"].rstrip("/") + '/v1/tool-runs/toolrun_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',
    headers=headers)
response.raise_for_status()
print(response.text)

Request

const base = process.env.SECURITY_RUN_URL.replace(/\/$/, "");
const headers = {};
headers.Authorization = `Bearer ${process.env.SECURITY_RUN_API_KEY}`;
const response = await fetch(base + "/v1/tool-runs/toolrun_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", {
  method: "GET",
  headers
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
console.log(await response.text());