# org.tangled.knot.describeKnot

> Published by [tangled.org](https://lexicon.garden/identity/did:plc:wshs7t2adsemcrrd4snkeqli)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:wshs7t2adsemcrrd4snkeqli/org.tangled.knot.describeKnot)
- [Documentation](https://lexicon.garden/lexicon/did:plc:wshs7t2adsemcrrd4snkeqli/org.tangled.knot.describeKnot/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:wshs7t2adsemcrrd4snkeqli/org.tangled.knot.describeKnot/examples)

## Definitions

### `org.tangled.knot.describeKnot#contact`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `email` | `string` | No |  |

### `org.tangled.knot.describeKnot#links`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `privacyPolicy` | `string` (uri) | No |  |
| `termsOfService` | `string` (uri) | No |  |

### `org.tangled.knot.describeKnot`

**Type**: `query`

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `capabilities` | `array` | No | Protocol capability tokens this knot implements. Knots that omit this field are treated as legacy. |
| `contact` | `ref` → `#contact` | No | Contact information |
| `did` | `string` (did) | Yes |  |
| `links` | `ref` → `#links` | No | URLs of service policy documents. |
| `version` | `string` | Yes |  |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "contact": {
      "properties": {
        "email": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "links": {
      "properties": {
        "privacyPolicy": {
          "format": "uri",
          "type": "string"
        },
        "termsOfService": {
          "format": "uri",
          "type": "string"
        }
      },
      "type": "object"
    },
    "main": {
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "capabilities": {
              "description": "Protocol capability tokens this knot implements. Knots that omit this field are treated as legacy.",
              "items": {
                "knownValues": [
                  "tangled1.0"
                ],
                "type": "string"
              },
              "type": "array"
            },
            "contact": {
              "description": "Contact information",
              "ref": "#contact",
              "type": "ref"
            },
            "did": {
              "format": "did",
              "type": "string"
            },
            "links": {
              "description": "URLs of service policy documents.",
              "ref": "#links",
              "type": "ref"
            },
            "version": {
              "type": "string"
            }
          },
          "required": [
            "did",
            "version"
          ],
          "type": "object"
        }
      },
      "type": "query"
    }
  },
  "id": "org.tangled.knot.describeKnot",
  "lexicon": 1
}
```