# social.colibri.beta.embed.trendingGifs

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

✓ This is the authoritative definition for this NSID.

## Links

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

## Definitions

### `social.colibri.beta.embed.trendingGifs`

**Type**: `query`

Gets trending GIFs from the GIF picker's provider.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `limit` | `integer` | No | Maximum number of GIFs to return. |
| `cursor` | `string` | No | Pagination cursor from a previous call. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `gifs` | `array` | Yes | Currently trending GIFs. |
| `cursor` | `string` | No | Pagination cursor for the next page. |

#### Errors

- **AuthRequired**: The request has no valid service auth.
- **GifsNotConfigured**: This AppView has no GIF provider key configured.
- **UpstreamFailure**: The GIF provider failed.

## Raw Schema

```json
{
  "id": "social.colibri.beta.embed.trendingGifs",
  "defs": {
    "main": {
      "type": "query",
      "errors": [
        {
          "name": "AuthRequired",
          "description": "The request has no valid service auth."
        },
        {
          "name": "GifsNotConfigured",
          "description": "This AppView has no GIF provider key configured."
        },
        {
          "name": "UpstreamFailure",
          "description": "The GIF provider failed."
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "gifs"
          ],
          "properties": {
            "gifs": {
              "type": "array",
              "items": {
                "ref": "social.colibri.beta.embed.defs#gifView",
                "type": "ref"
              },
              "description": "Currently trending GIFs."
            },
            "cursor": {
              "type": "string",
              "description": "Pagination cursor for the next page."
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "properties": {
          "limit": {
            "type": "integer",
            "default": 50,
            "maximum": 100,
            "minimum": 1,
            "description": "Maximum number of GIFs to return."
          },
          "cursor": {
            "type": "string",
            "description": "Pagination cursor from a previous call."
          }
        }
      },
      "description": "Gets trending GIFs from the GIF picker's provider."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```