Skip to main content
API reference sections

Schema

RunFolder

One run's folder, as the surface reads it.

registered is how many versions the run has already produced, so D29's state - finished having registered nothing - is a fact the surface can state rather than infer from an empty list it might simply not have fetched. folder_present separates the agent wrote nothing from the folder is gone, which are different sentences.

Type object

Shape

FieldTypeDescription
runrequiredRunId
workspacerequiredWorkspaceId
folder_presentrequiredboolean

<run-workspace>/.artifacts/<RunId>/ exists and could be read.

registeredrequiredinteger (uint, >= 0)

Versions this run has registered.

unregisteredrequiredarray of UnregisteredFile

Files in the folder that are not results, shallowest first then by path, at most [MAX_RUN_FOLDER_FILES].

truncatedrequiredboolean

The folder held more than the scan's bounds allow.

Example
{
  "run": "00000000-0000-4000-8000-000000000000",
  "workspace": "00000000-0000-4000-8000-000000000000",
  "folder_present": false,
  "registered": 0,
  "unregistered": [
    {
      "path": "string",
      "size_bytes": 0,
      "modified_at_ms": 0
    }
  ],
  "truncated": false
}

The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.

Generated from contract version 1. Last updated .

Privacy choices

Choose which optional tools Koru may use on this site. Your choice is saved in a cookie in this browser for 12 months. Privacy policy

Privacy choices

Keep you signed in, protect forms and remember your language and this choice.

Always on

PostHog and Google Analytics 4 measure page views and actions such as downloads, using cookies or local storage.

PostHog records how pages are used, with form inputs masked and private pages excluded. Needs Analytics.

Ahrefs Web Analytics measures visits and where they come from, and Google Ads measures whether our ads led to a visit or download.