garden.engram.getSpaceStatus

hailey.at

Documentation

Summarize a space's index: its declared model, how many memories are indexed, and which authors have memories that weren't indexed because their vectors don't match the space's model. Same authentication as garden.engram.searchMemories.

main query

Summarize a space's index: its declared model, how many memories are indexed, and which authors have memories that weren't indexed because their vectors don't match the space's model. Same authentication as garden.engram.searchMemories.

Parameters

space string Required

The space URI.

Output

Encodingapplication/json
access ref#access Optional

No description available.

buildingMemories integer Optional

During a model change: memories that already have a vector for the next model.

config unknown Optional

The space's garden.engram.config, as last seen.

memories integer Required

No description available.

skipped array Required

No description available.

Errors

UnknownSpace This service does not index the space.
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
The space URI.
View raw schema 
{
  "description": "Summarize a space's index: its declared model, how many memories are indexed, and which authors have memories that weren't indexed because their vectors don't match the space's model. Same authentication as garden.engram.searchMemories.",
  "errors": [
    {
      "description": "This service does not index the space.",
      "name": "UnknownSpace"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "access": {
          "ref": "#access",
          "type": "ref"
        },
        "active": {
          "ref": "garden.engram.defs#model",
          "type": "ref"
        },
        "building": {
          "ref": "garden.engram.defs#model",
          "type": "ref"
        },
        "buildingMemories": {
          "description": "During a model change: memories that already have a vector for the next model.",
          "type": "integer"
        },
        "config": {
          "description": "The space's garden.engram.config, as last seen.",
          "type": "unknown"
        },
        "memories": {
          "type": "integer"
        },
        "skipped": {
          "items": {
            "ref": "#skippedAuthor",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "memories",
        "skipped"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "space": {
        "description": "The space URI.",
        "type": "string"
      }
    },
    "required": [
      "space"
    ],
    "type": "params"
  },
  "type": "query"
}
access object

Whether the appview may read the space, to keep its index current.

Properties

error string Optional

Why the grant lapsed.

grantedAt string datetime Optional

An RFC 3339 formatted timestamp.

grantedBy string did Optional

A decentralized identifier (DID).

state string Required

granted: the authority granted read access. missing: nobody has; the index isn't updated. lapsed: the authority's server refused the grant the last time it was used; grant again.

Known values: granted, missing, lapsed
View raw schema 
{
  "description": "Whether the appview may read the space, to keep its index current.",
  "properties": {
    "error": {
      "description": "Why the grant lapsed.",
      "type": "string"
    },
    "grantedAt": {
      "format": "datetime",
      "type": "string"
    },
    "grantedBy": {
      "format": "did",
      "type": "string"
    },
    "state": {
      "description": "granted: the authority granted read access. missing: nobody has; the index isn't updated. lapsed: the authority's server refused the grant the last time it was used; grant again.",
      "knownValues": [
        "granted",
        "missing",
        "lapsed"
      ],
      "type": "string"
    }
  },
  "required": [
    "state"
  ],
  "type": "object"
}
skippedAuthor object

No description available.

Properties

author string did Required

A decentralized identifier (DID).

count integer Required

No description available.

View raw schema 
{
  "properties": {
    "author": {
      "format": "did",
      "type": "string"
    },
    "count": {
      "type": "integer"
    }
  },
  "required": [
    "author",
    "count"
  ],
  "type": "object"
}

Lexicon Garden

@