Skip to main content
GET
Read a memory tier

Authorizations

Authorization
string
header
required

An organization-scoped API key, minted in control under Settings → API keys. Every failure to authenticate answers one identical 401: "Provide a valid organization-scoped API key or an active session." Each operation names the one scope it is filed under, <resource>:<read|write>, where the resource is the first path segment after /api/v1/; a key minted today carries all 22 of them. Scopes are RECORDED — on the key and on every audit row — and are not yet enforced: no request is refused for want of one.

Path Parameters

id
string
required

The ework id. A malformed id answers 404, exactly as another organization's well-formed id does.

Query Parameters

repoId
string

Which tier to read. Omit it and the answer is {tierRepos: […]} — the tiers this ework can reach, which is how you discover the ids the other calls take.

path
string

Path from the repository root. Defaults to the root.

read
string

Any non-empty value asks for the FILE at path ({file: …}) rather than a listing ({entries: […]}).

Response

Success.

data
object
required

Which of the three shapes comes back is decided by the query, not by the state of anything.