kythene.v1.KytheneService

Brief

Brief is the single session-opening call: workspace guide + catchup delta + project memory index + inbox, compact enough to prime a session in one shot.

post/kythene.v1.KytheneService/Brief

Request

  • Base URL: https://kythene.com (the document declares no server; this is the origin it was published from)
  • URL: https://kythene.com/kythene.v1.KytheneService/Brief
  • Auth: none required

Headers

Connect-Protocol-Version1 required

Define the version of the Connect protocol

Connect-Timeout-Msnumber

Define the timeout, in ms

Request body

projectstring

project optionally scopes the memory index to one project (a project-kind tag name, or the value from resolve_project); empty briefs the whole workspace.

peekboolean

peek reads the catchup delta without advancing the cursor. Default false: brief is the session opener, so it consumes the delta like catchup does.

spacestring

space optionally selects which of your spaces to brief (an id or name from list_spaces). Omit it when you belong to a single space.

Response

Success

workspaceIdstring
workspaceNamestring
projectstring

project is the scope the index reflects (empty = the whole workspace).

guidestring

guide is the workspace operating manual - the house rules for working here.

catchupstring[]

catchup lists, compactly, what changed since this instance last looked (publishes, versions, feedback, promotions) - excluding your own instance's writes. catchup_more counts entries beyond this list; first_look is true for a brand-new instance with no delta window yet.

catchupMoreinteger
firstLookboolean
memoryTotalinteger

memory_total is how many memories are in scope; the index may be capped to keep the brief compact, so total greater than len(memory_index) means there is more - recall to page it.

inboxCountinteger

inbox_count is how many items await you across your workspaces; headlines is a short preview of the most recent.

inboxHeadlinesstring[]
truncatedboolean

truncated is true when any list here was capped to keep the brief small, so a reader knows it has not seen everything (rather than mistaking the cap for the whole - the manufactured-absence trap).

startHerestring

start_here is set ONLY when this workspace holds no memories at all, and it carries what to do about that (#153). An empty workspace is the one state where every other field is blank and the tools all look broken: recall returns nothing, so the assistant reasonably concludes Kythene has nothing to offer and stops calling it - the workspace then stays empty forever. This is the instruction that breaks that loop, and it is delivered HERE because brief is the one call every client is told to make first, whether it loaded a skill, a plugin or nothing at all. It disappears by itself the moment the workspace has content, so it can never become stale advice.

Do not confuse it with first_look, which is about this INSTANCE's cursor: a brand-new instance connecting to a mature workspace sets first_look and must NOT be given onboarding.

Example response

{
  "memoryIndex": [
    {
      "updatedAt": "2023-01-15T01:30:15.01Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.