# site.exosphere.sphere.profile

> Published by [exosphere.site](https://lexicon.garden/identity/did:plc:tztfs5zp6b4feo4u64adfvmq)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:tztfs5zp6b4feo4u64adfvmq/site.exosphere.sphere.profile)
- [Documentation](https://lexicon.garden/lexicon/did:plc:tztfs5zp6b4feo4u64adfvmq/site.exosphere.sphere.profile/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:tztfs5zp6b4feo4u64adfvmq/site.exosphere.sphere.profile/examples)

## Definitions

### `site.exosphere.sphere.profile`

**Type**: `record`

Declaration of an Exosphere Sphere, published on the owner's PDS. Enables third-party discovery and indexing of Spheres across the AT Protocol network.

**Key**: `literal:self`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `name` | `string` | Yes | Human-readable display name. |
| `modules` | `array` | No | Module names enabled for this Sphere. |
| `createdAt` | `string` (datetime) | Yes |  |
| `visibility` | `string` | Yes | Whether the Sphere's content is publicly readable. |
| `description` | `string` | No | Short description of the Sphere's purpose. |

## Raw Schema

```json
{
  "id": "site.exosphere.sphere.profile",
  "defs": {
    "main": {
      "key": "literal:self",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "name",
          "visibility",
          "createdAt"
        ],
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 256,
            "description": "Human-readable display name."
          },
          "modules": {
            "type": "array",
            "items": {
              "type": "string",
              "maxLength": 256
            },
            "description": "Module names enabled for this Sphere."
          },
          "createdAt": {
            "type": "string",
            "format": "datetime",
            "maxLength": 64
          },
          "visibility": {
            "type": "string",
            "maxLength": 64,
            "description": "Whether the Sphere's content is publicly readable.",
            "knownValues": [
              "public",
              "private"
            ]
          },
          "description": {
            "type": "string",
            "maxLength": 1024,
            "description": "Short description of the Sphere's purpose."
          }
        }
      },
      "description": "Declaration of an Exosphere Sphere, published on the owner's PDS. Enables third-party discovery and indexing of Spheres across the AT Protocol network."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```