social.colibri.beta.embed.trendingGifs Documentation (EN)

main query

Gets trending GIFs from the GIF picker's provider.

Parameters

cursor string Optional

Pagination cursor from a previous call.

limit integer Optional

Maximum number of GIFs to return.

Output

Encodingapplication/json

cursor string Optional

Pagination cursor for the next page.

gifs array Required

Currently trending GIFs.

Errors

AuthRequired The request has no valid service auth.

GifsNotConfigured This AppView has no GIF provider key configured.

UpstreamFailure The GIF provider failed.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

cursor Pagination cursor from a previous call.

limit Maximum number of GIFs to return.

View raw schema

{
  "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."
}