# so.sprk.feed.describeFeedGenerator

> Published by [sprk.so](https://lexicon.garden/identity/did:plc:cveom2iroj3mt747sd4qqnr2)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:cveom2iroj3mt747sd4qqnr2/so.sprk.feed.describeFeedGenerator)
- [Documentation](https://lexicon.garden/lexicon/did:plc:cveom2iroj3mt747sd4qqnr2/so.sprk.feed.describeFeedGenerator/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:cveom2iroj3mt747sd4qqnr2/so.sprk.feed.describeFeedGenerator/examples)

## Definitions

### `so.sprk.feed.describeFeedGenerator#feed`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `uri` | `string` (at-uri) | Yes |  |

### `so.sprk.feed.describeFeedGenerator`

**Type**: `query`

Get information about a feed generator, including policies and offered feed URIs. Does not require auth; implemented by Feed Generator services (not App View).

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` (did) | Yes |  |
| `feeds` | `array` | Yes |  |
| `links` | `ref` → `#links` | No |  |

### `so.sprk.feed.describeFeedGenerator#links`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `privacyPolicy` | `string` | No |  |
| `termsOfService` | `string` | No |  |

## Raw Schema

```json
{
  "id": "so.sprk.feed.describeFeedGenerator",
  "defs": {
    "feed": {
      "type": "object",
      "required": [
        "uri"
      ],
      "properties": {
        "uri": {
          "type": "string",
          "format": "at-uri"
        }
      }
    },
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "did",
            "feeds"
          ],
          "properties": {
            "did": {
              "type": "string",
              "format": "did"
            },
            "feeds": {
              "type": "array",
              "items": {
                "ref": "#feed",
                "type": "ref"
              }
            },
            "links": {
              "ref": "#links",
              "type": "ref"
            }
          }
        },
        "encoding": "application/json"
      },
      "description": "Get information about a feed generator, including policies and offered feed URIs. Does not require auth; implemented by Feed Generator services (not App View)."
    },
    "links": {
      "type": "object",
      "properties": {
        "privacyPolicy": {
          "type": "string"
        },
        "termsOfService": {
          "type": "string"
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```
