Skip to content
Slingshot

Overview

@lastshotlabs/slingshot-gifs is a thin server-side proxy for GIF search providers. It keeps the provider API key on the server, normalizes provider responses, and gives clients one stable interface whether the backend is Giphy or Tenor.

When To Use It

Section titled “When To Use It”

Use this package when your app needs:

  • GIF search and trending endpoints for chat, comments, or composer UIs
  • provider API keys to remain server-side
  • the ability to swap between Giphy and Tenor without changing client payload shape

Do not use it if you want clients to call provider APIs directly. This package exists to centralize credentials and response normalization.

Minimum Setup

Section titled “Minimum Setup”

The required config is:

  • provider: 'giphy' | 'tenor'
  • apiKey

The optional config is:

  • rating
  • limit, which defaults to 25
  • mountPath, which defaults to /gifs

The package has no additional Slingshot package dependencies.

What You Get

Section titled “What You Get”

The plugin mounts:

  • GET {mountPath}/trending
  • GET {mountPath}/search?q=...

Both routes return normalized results with:

  • id
  • url
  • preview
  • width
  • height
  • title

The API key never leaves the server. Clients only see the normalized result set.

Common Customization

Section titled “Common Customization”

The highest-value knobs are:

  • provider: choose the operational backend
  • rating: align results with your product’s content policy
  • limit: set a stable page size for UI grids
  • mountPath: fit the route into your app’s API layout

If you need to extend provider behavior, start in:

  • src/plugin.ts for route behavior
  • src/types.ts for the shared provider contract
  • src/providers/giphy.ts and src/providers/tenor.ts for backend-specific mapping

Gotchas

Section titled “Gotchas”
  • Search requires the q query parameter and returns 400 when it is missing or blank.
  • Provider-specific rating vocabularies still apply. The plugin passes rating through rather than inventing a cross-provider moderation policy.
  • The plugin normalizes response shape, not every backend quirk. If you depend on provider-only fields, you are breaking the abstraction boundary.

Key Files

Section titled “Key Files”
  • src/index.ts
  • src/plugin.ts
  • src/types.ts
  • src/providers/giphy.ts
  • src/providers/tenor.ts