# social.colibri.embed.getMetadata

> Published by [colibri.social](https://lexicon.garden/identity/did:plc:mprdjqjluoswa7awzggaggj3)

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.embed.getMetadata)
- [Documentation](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.embed.getMetadata/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.embed.getMetadata/examples)

## Definitions

### `social.colibri.embed.getMetadata`

**Type**: `query`

Fetches Open Graph-style link preview metadata for a URL.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `uri` | `string` | Yes |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `image` | `array` | Yes |  |
| `title` | `string` | No |  |
| `siteName` | `string` | No |  |
| `largeImage` | `boolean` | No |  |
| `themeColor` | `string` | No |  |
| `description` | `string` | No |  |

#### Errors

- **AuthRequired**: Missing, malformed, or unverifiable service auth.
- **InvalidRequest**: A parameter or body field was missing or malformed.

## Raw Schema

```json
{
  "id": "social.colibri.embed.getMetadata",
  "defs": {
    "main": {
      "type": "query",
      "errors": [
        {
          "name": "AuthRequired",
          "description": "Missing, malformed, or unverifiable service auth."
        },
        {
          "name": "InvalidRequest",
          "description": "A parameter or body field was missing or malformed."
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "image"
          ],
          "properties": {
            "image": {
              "type": "array",
              "items": {
                "ref": "lex:social.colibri.embed.defs#embedImage",
                "type": "ref"
              }
            },
            "title": {
              "type": "string"
            },
            "siteName": {
              "type": "string"
            },
            "largeImage": {
              "type": "boolean"
            },
            "themeColor": {
              "type": "string"
            },
            "description": {
              "type": "string"
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "uri"
        ],
        "properties": {
          "uri": {
            "type": "string"
          }
        }
      },
      "description": "Fetches Open Graph-style link preview metadata for a URL."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```