Skip to main content
API reference sections

Schema

RunWorkspaceResponse

GET /v1/artifacts/authorities/{run}/workspace: the one answer that carries the run's working folder back out of the store.

[AuthorityView] deliberately carries no path, and that is still the rule for every read a surface makes. This is the exception, for the one caller that needs it: emptying the trash has to remove the folder a deleted run worked in, and the record is the only durable place that folder is written down - the scope says what kind of folder was asked for, and only the device that ran it knows which directory that turned out to be. Re-deriving it from the scope now would name a different directory whenever a project has moved or a temporary base has been repointed, which is how a delete removes the wrong thing.

It is behind the write scope, not the read one. Reading it is not what it is for: a person's absolute path leaves this store only into the hand that is about to delete the folder, and the fence should say so.

Its Debug prints no path, like every other type that holds one.

Type object

Shape

FieldTypeDescription
runrequiredRunId
run_workspacerequiredRunWorkspace

The run's working scope on this device. A path is content (standing requirement 7): it is stored so the gateway can resolve Register paths against it, and it is redacted from every Debug rendering.

Example
{
  "run": "00000000-0000-4000-8000-000000000000",
  "run_workspace": "string"
}

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

Used by

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.