# garden.engram.getSpaceStatus

> Published by [hailey.at](https://lexicon.garden/identity/did:plc:oisofpd7lj26yvgiivf3lxsi)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:oisofpd7lj26yvgiivf3lxsi/garden.engram.getSpaceStatus)
- [Documentation](https://lexicon.garden/lexicon/did:plc:oisofpd7lj26yvgiivf3lxsi/garden.engram.getSpaceStatus/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:oisofpd7lj26yvgiivf3lxsi/garden.engram.getSpaceStatus/examples)

## Definitions

### `garden.engram.getSpaceStatus#access`

**Type**: `object`

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

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `error` | `string` | No | Why the grant lapsed. |
| `grantedAt` | `string` (datetime) | No |  |
| `grantedBy` | `string` (did) | No |  |
| `state` | `string` | Yes | 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. |

### `garden.engram.getSpaceStatus`

**Type**: `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

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `space` | `string` | Yes | The space URI. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `access` | `ref` → `#access` | No |  |
| `active` | `ref` → `garden.engram.defs#model` | No |  |
| `building` | `ref` → `garden.engram.defs#model` | No |  |
| `buildingMemories` | `integer` | No | During a model change: memories that already have a vector for the next model. |
| `config` | `unknown` | No | The space's garden.engram.config, as last seen. |
| `memories` | `integer` | Yes |  |
| `skipped` | `array` | Yes |  |

#### Errors

- **UnknownSpace**: This service does not index the space.

### `garden.engram.getSpaceStatus#skippedAuthor`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `author` | `string` (did) | Yes |  |
| `count` | `integer` | Yes |  |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "access": {
      "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"
    },
    "main": {
      "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"
    },
    "skippedAuthor": {
      "properties": {
        "author": {
          "format": "did",
          "type": "string"
        },
        "count": {
          "type": "integer"
        }
      },
      "required": [
        "author",
        "count"
      ],
      "type": "object"
    }
  },
  "id": "garden.engram.getSpaceStatus",
  "lexicon": 1
}
```