### Swift ViewController using KlipyWebView

Source: https://docs.klipy.com/advertisements/receiving-an-ad/browser-like-user-agent

Example ViewController that sets up a KlipyWebView, adds it to a wrapper view with Auto Layout constraints, and loads an HTML string that dynamically changes the heading text. Requires importing KlipyAds and installing the SDK via CocoaPods.

```Swift
import UIKit
import KlipyAds

class ViewController: UIViewController {
  private lazy var wrapperView: UIView = {
    return UIView(frame: .zero)
  }()
  
  private lazy var klipyWebview: KlipyWebView = {
    return KlipyWebView()
  }()
  
  override func viewDidLoad() {
    super.viewDidLoad()
    
    setup()
    layout()
    loadHTML()
  }
  
  override func viewDidAppear(_ animated: Bool) {
    super.viewDidAppear(animated)
  }
  
  private func setup() {
    view.addSubview(wrapperView)
    wrapperView.addSubview(klipyWebview)
  }
  
  private func layout() {
    wrapperView.translatesAutoresizingMaskIntoConstraints = false
    NSLayoutConstraint.activate([
      wrapperView.centerXAnchor.constraint(equalTo: view.centerXAnchor),
      wrapperView.centerYAnchor.constraint(equalTo: view.centerYAnchor),
      wrapperView.widthAnchor.constraint(equalToConstant: 300),
      wrapperView.heightAnchor.constraint(equalToConstant: 200)
    ])
    
    klipyWebview.translatesAutoresizingMaskIntoConstraints = false
    NSLayoutConstraint.activate([
      klipyWebview.topAnchor.constraint(equalTo: wrapperView.topAnchor),
      klipyWebview.bottomAnchor.constraint(equalTo: wrapperView.bottomAnchor),
      klipyWebview.leadingAnchor.constraint(equalTo: wrapperView.leadingAnchor),
      klipyWebview.trailingAnchor.constraint(equalTo: wrapperView.trailingAnchor)
    ])
  }
  
  private func loadHTML() {
    klipyWebview.loadHTMLString(htmlString: "<h1>Hello, World!</h1><script>document.querySelector('h1').innerHTML = 'Hello, Klipy!';</script>")
  }
}
```

--------------------------------

### Install KlipyAds via CocoaPods

Source: https://docs.klipy.com/advertisements/receiving-an-ad

Add the KlipyAds pod to your Podfile to install the SDK. After installation, import KlipyAds in your Swift code.

```ruby
pod 'KlipyAds'
```

--------------------------------

### Example response for search suggestions

Source: https://docs.klipy.com/migrate-from-tenor/categories

Example JSON response from the search suggestions endpoint. It includes the locale and an array of suggested search terms.

```json
{
  "locale": "en",
  "results": [
    "good morning march",
    "good morning",
    "hood",
    "good night",
    "good job",
    "food",
    "thumbs up",
    "good good",
    "goodnight",
    "great",
    "palpatine",
    "good luck",
    "yay",
    "yes",
    "excellent",
    "im good",
    "ok",
    "good afternoon",
    "nice",
    "morning"
  ]
}
```

--------------------------------

### Autocomplete response example

Source: https://docs.klipy.com/migrate-from-tenor/categories

Example JSON response from the autocomplete endpoint, showing a locale and an array of suggestion strings.

```json
{
  "locale": "en",
  "results": [
    "good night",
    "good morning",
    "good morning quotes",
    "good night kiss",
    "good morning images",
    "good night images",
    "good morning love",
    "good morning kiss",
    "good afternoon",
    "good evening",
    "good",
    "good night love",
    "good morning my love",
    "good luck",
    "goodnight and i love you",
    "good night sweet dreams",
    "good night my love",
    "good morning baby",
    "good afternoon images",
    "good evening images"
  ]
}
```

--------------------------------

### Example response from /v2/trending_terms

Source: https://docs.klipy.com/migrate-from-tenor/categories

Example JSON response returned by the endpoint. It contains a locale string and an array of trending search terms.

```json
{
  "locale": "en",
  "results": [
    "happy victory day",
    "merry christmas funny",
    "happy hanukkah",
    "december",
    "2026",
    "merry christmas and happy new year",
    "brain smile",
    "john cena",
    "bangladesh",
    "jax"
  ]
}
```

--------------------------------

### Example response for Search Suggestions endpoint

Source: https://docs.klipy.com/search-suggestions-and-autocomplete/autocomplete

Example JSON response from the Search Suggestions endpoint. The response contains a result boolean and a data array of suggested search terms.

```json
{
  "result": true,
  "data": [
    "hello there",
    "hi",
    "hello its me",
    "hey",
    "well hello",
    "you there",
    "good morning",
    "hello kitty",
    "waiting",
    "wave",
    "are you there",
    "helloo",
    "anyone there",
    "jello",
    "where are you",
    "hugs",
    "hello love",
    "miss you",
    "mrs doubtfire",
    "ok",
    "hello cat",
    "hello beautiful",
    "hello chat",
    "hello are you there",
    "hello guys",
    "hello september",
    "hello friend",
    "hello baby",
    "hello friends",
    "hello neighbor subscribe"
  ]
}
```

--------------------------------

### API Response Example

Source: https://docs.klipy.com/advertisements/receiving-an-ad/browser-like-user-agent

Example JSON response from the ad API, containing the HTML content and dimensions.

```json
{
  "content": "<advertisement_html>...</advertisement_html>",
  "width": 250,
  "height": 300,
  "type": "ad"
}
```

--------------------------------

### Get User-Agent (Android)

Source: https://docs.klipy.com/advertisements/receiving-an-ad/browser-like-user-agent

Code example for retrieving a browser-like User-Agent string from an Android WebView, as required for ad requests.

```APIDOC
## Get User-Agent (Android)

### Description
Retrieves a browser-like User-Agent string from an Android WebView, as required for ad requests.

### Method
N/A (SDK code example)

### Endpoint
N/A

### Parameters
None

### Request Example
```java
import android.os.Bundle;
import android.webkit.WebView;
import androidx.appcompat.app.AppCompatActivity;

public class MainActivity extends AppCompatActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        // ... some code here
        String userAgent = getUA();
    }

    private String getUA() {
        return new WebView(this).getSettings().getUserAgentString();
    }
}
```

### Response
Returns a string containing the User-Agent.
```

--------------------------------

### GET Posts (Migrate from Tenor)

Source: https://docs.klipy.com/ai-emoji-api/ai-emojis-trending-api

Retrieves posts using the Tenor-compatible API. This endpoint is part of the migration guide and returns post objects.

```APIDOC
## GET Posts (Migrate from Tenor)

### Description
Retrieves posts using the Tenor-compatible API.

### Method
GET

### Endpoint
Posts

### Parameters
#### Query Parameters
- **ids** (string) - Required - Comma-separated list of post IDs.

### Response
#### Success Response (200)
- **results** (array) - List of post objects.

#### Response Example
{
  "results": []
}
```

--------------------------------

### GET Autocomplete (Migrate from Tenor)

Source: https://docs.klipy.com/ai-emoji-api/ai-emojis-trending-api

Retrieves autocomplete suggestions using the Tenor-compatible API. This endpoint is part of the migration guide and returns autocomplete terms.

```APIDOC
## GET Autocomplete (Migrate from Tenor)

### Description
Retrieves autocomplete suggestions using the Tenor-compatible API.

### Method
GET

### Endpoint
Autocomplete

### Parameters
#### Query Parameters
- **q** (string) - Required - The search query.

### Response
#### Success Response (200)
- **suggestions** (array) - List of autocomplete terms.

#### Response Example
{
  "suggestions": []
}
```

--------------------------------

### Autocomplete API response example

Source: https://docs.klipy.com/search-suggestions-and-autocomplete/autocomplete

Example JSON response from the Autocomplete endpoint. The result field is true and data contains an array of suggested search terms.

```json
{
  "result": true,
  "data": [
    "hello",
    "heart",
    "he he",
    "hehehe",
    "hey",
    "hearts",
    "hello kitty",
    "hell yeah",
    "heart images",
    "hello there",
    "headache",
    "heartbreak",
    "heart broken",
    "head massage",
    "hehehehe",
    "hell divers",
    "heart attack",
    "head pat",
    "help",
    "hero",
    "hell no",
    "head kiss",
    "hell",
    "heart eyes",
    "help me",
    "heart beat",
    "heh",
    "hell nah",
    "heaven",
    "heyy"
  ]
}
```

--------------------------------

### 200 response for GET /api/v1/{app_key}/clips/items

Source: https://docs.klipy.com/clips-api/clips-categories-api

Example 200 response for the Clip Items API. The response contains a result boolean and a data object with an array of clip objects, each including url, title, slug, file URLs (mp4, gif, webp), file_meta dimensions, tags, type, and a base64 blur_preview.

```json
{
  "result": true,
  "data": {
    "data": [
      {
        "url": "https://klipy.com/clips/they-love-me-spider-man",
        "title": "They love me - Spider-man",
        "slug": "they-love-me-spider-man",
        "file": {
          "mp4": "https://static.klipy.com/ii/d0f4326653a6a0faab99b9987b9a194d/06/8b/QO60JGjF.mp4",
          "gif": "https://static.klipy.com/ii/d0f4326653a6a0faab99b9987b9a194d/06/8b/adW975M3.gif",
          "webp": "https://static.klipy.com/ii/d0f4326653a6a0faab99b9987b9a194d/06/8b/TyGnppPI.webp"
        },
        "file_meta": {
          "mp4": {
            "width": 1280,
            "height": 592
          },
          "gif": {
            "width": 320,
            "height": 148
          },
          "webp": {
            "width": 320,
            "height": 148
          }
        },
        "tags": [],
        "type": "clip",
        "blur_preview": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAgAAJgAlAAD//gARTGF2YzU4LjEzNC4xMDAA/9sAQwAIBAQEBAQFBQUFBQUGBgYGBgYGBgYGBgYGBwcHCAgIBwcHBgYHBwgICAgJCQkICAgICQkKCgoMDAsLDg4OEREU/8QAgQAAAgMBAQEAAAAAAAAAAAAABwMABgUBBAIBAQEBAQAAAAAAAAAAAAAAAAMBAgQQAAEDAwIFAgILAQAAAAAAAAEEAwIAEQUSBjFBEyEHQhQIgVNykXFSFySTMyKxIxEAAgEDAwQDAQAAAAAAAAAAAQIABAMRcTIhMQVBEoIzgbH/wAARCAATACgDASIAAhEAAxEA/9oADAMBAAIRAxEAPwAfeHfH+3d5Icg7lIOzmw7CDehww7GN6tqjw146TPssTbUhx4kQHuDyF6oPjzIu4vHLFLSp1LIPwjeEjY3Ha8edWSW8FD2bQxWOBS+1/wBG5D+vYfisarXraKMjUzdmmu37mE5J6CMh4k2pLOJU8m1Oh6bg6MHLiMBe0pT43HOt38idifQKv3zWK1vpvbeddya0e468dBbBsGry9FEPCZhFncWxkU8rNOg2ErAgjiPlVpHS4pyQxycaTXcKa7Tuo9Cg9RnnzBH5i8e7e2agxz2LbdhJ92cJ63DPsI3HGh/Rb+IyUZYrD2kD+oc4G/poSVbgAfiEhJWfcH3m4mMHJxiSCQJEAkc677tV1Op1nNfDVqOr7b0upRXtp0Meh+9dV/sY4qUvfyOuT+tIn/aexnc0mZDTOQWNNg3EIPTjEfIG1eSpyqUnj9i903v8Y9Xk8ivjGKpWoUCPeIdclMD7tRNIqVKV90416T//2Q=="
      }
    ]
  }
}
```

--------------------------------

### GET Autocomplete (Migrate from Tenor)

Source: https://docs.klipy.com/gifs-api/gifs-items-api

Autocomplete endpoint for migrating from Tenor.

```APIDOC
## GET Autocomplete

### Description
Autocomplete endpoint for migrating from Tenor.

### Method
GET

### Endpoint
Autocomplete

### Parameters
No parameters documented.

### Response
No response schema documented.

```

--------------------------------

### Example JSON response for Categories API

Source: https://docs.klipy.com/ai-emoji-api/ai-emojis-generation/ai-emojis-generate-api

Example 200 response showing the structure of the returned data. The data object contains the locale and an array of categories, each with a category name, query, and preview URL.

```json
{
  "result": true,
  "data": {
    "locale": "en_US",
    "categories": [
      {
        "category": "smile",
        "query": "smile",
        "preview_url": "https://static.klipy.com/ii/e293a233a303a98e471f78d04e13a1b0/a5/fd/NnGoLmO8.gif"
      },
      {
        "category": "aww",
        "query": "aww",
        "preview_url": "https://static.klipy.com/ii/925f17378dd1893b674a723c07535afe/1c/24/Oizp49sT.gif"
      },
      {
        "category": "high five",
        "query": "high five",
        "preview_url": "https://static.klipy.com/ii/925f17378dd1893b674a723c07535afe/d9/e6/rtepipfC.gif"
      },
      {
        "category": "good morning",
        "query": "good morning",
        "preview_url": "https://static.klipy.com/ii/ce286d05b8e1a47cd4f32b0e1b6dec0e/a6/f3/SEmLt8aA.gif"
      },
      {
        "category": "good night",
        "query": "good night",
        "preview_url": "https://static.klipy.com/ii/f87f46a2c5aeaeed4c68910815f73eaf/af/77/35MgTkW5.gif"
      }
    ]
  }
}
```

--------------------------------

### Sample JSON Response from /v2/featured

Source: https://docs.klipy.com/migrate-from-tenor/content-filtering

Example 200 response showing the structure with locale, results array, and media_formats for each GIF.

```json
{
  "locale": "en",
  "results": [
    {
      "id": "5985319072776906",
      "title": "Spongebob Squarepants Christmas Dance",
      "media_formats": {
        "gif": {
          "url": "https://static.klipy.com/ii/39f2394ae36df6e199be9eb7c9fa1012/d7/83/RI8jLl47.gif",
          "duration": 0,
          "preview": "",
          "dims": [
            498,
            379
          ],
          "size": 1037778
        },
        "mediumgif": {
          "url": "https://static.klipy.com/ii/39f2394ae36df6e199be9eb7c9fa1012/d7/83/LaqbDu1b.gif",
          "duration": 0,
          "preview": "",
          "dims": [
            640,
            488
          ],
          "size": 753676
        },
        "tinygif": {
          "url": "https://static.klipy.com/ii/39f2394ae36df6e199be9eb7c9fa1012/d7/83/dkpdf8yW.gif",
          "duration": 0,
          "preview": "",
          "dims": [
            220,
            168
          ],
          "size": 97672
        },
        "nanogif": {
          "url": "https://static.klipy.com/ii/39f2394ae36df6e199be9eb7c9fa1012/d7/83/AaO4GzzE.gif",
          "duration": 0,
          "preview": "",
          "dims": [
            220,
            168
          ],
          "size": 97672
        }
      }
    }
  ],
  "next": ""
}
```

--------------------------------

### GET Categories (Migrate from Tenor)

Source: https://docs.klipy.com/ai-emoji-api/ai-emojis-trending-api

Retrieves categories using the Tenor-compatible API. This endpoint is part of the migration guide and returns a list of categories.

```APIDOC
## GET Categories (Migrate from Tenor)

### Description
Retrieves categories using the Tenor-compatible API.

### Method
GET

### Endpoint
Categories

### Response
#### Success Response (200)
- **categories** (array) - List of category objects.

#### Response Example
{
  "categories": []
}
```

--------------------------------

### GET Search (Migrate from Tenor)

Source: https://docs.klipy.com/ai-emoji-api/ai-emojis-trending-api

Searches for content using the Tenor-compatible API. This endpoint is part of the migration guide and returns search results.

```APIDOC
## GET Search (Migrate from Tenor)

### Description
Searches for content using the Tenor-compatible API.

### Method
GET

### Endpoint
Search

### Parameters
#### Query Parameters
- **q** (string) - Required - Search query.

### Response
#### Success Response (200)
- **results** (array) - List of search results.

#### Response Example
{
  "results": []
}
```

--------------------------------

### Create KlipyContent data model

Source: https://docs.klipy.com/advertisements/receiving-an-ad/browser-like-user-agent

Creates a KlipyContent instance with customizable fields: isWebView, content (HTML/JS), width, and height. This example sets content to display 'Hello, Klipy!'.

```kotlin
val klipyContent = KlipyContent(
  isWebView = true,
  content = "<h1>Hello, World!</h1><script>document.querySelector('h1').innerHTML = 'Hello, Klipy!';</script>",
  width = 200,
  height = 110
)
```

--------------------------------

### GET Featured (Migrate from Tenor)

Source: https://docs.klipy.com/ai-emoji-api/ai-emojis-trending-api

Retrieves featured content using the Tenor-compatible API. This endpoint is part of the migration guide and returns featured items.

```APIDOC
## GET Featured (Migrate from Tenor)

### Description
Retrieves featured content using the Tenor-compatible API.

### Method
GET

### Endpoint
Featured

### Response
#### Success Response (200)
- **results** (array) - List of featured items.

#### Response Example
{
  "results": []
}
```

--------------------------------

### Example: Correct vs Incorrect User-Agent

Source: https://docs.klipy.com/advertisements/receiving-an-ad/browser-like-user-agent

Shows the difference between an application-level User-Agent (incorrect) and a browser-like User-Agent (correct) for ad requests.

```text
APP_NAME/1 CFNetwork/1474 Darwin/23.1.0
```

```text
Mozilla/5.0 (iPhone; CPU iPhone OS 17_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148
```

--------------------------------

### Android: Retrieve User-Agent from WebView

Source: https://docs.klipy.com/advertisements/receiving-an-ad/browser-like-user-agent

Use WebView.getSettings().getUserAgentString() to get a browser-like User-Agent for ad requests. The example shows a method that returns the User-Agent string.

```java
import android.os.Bundle;
import android.webkit.WebView;
import androidx.appcompat.app.AppCompatActivity;

public class MainActivity extends AppCompatActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        // ... some code here
        String userAgent = getUA();
    }

    private String getUA() {
        return new WebView(this).getSettings().getUserAgentString();
    }
}
```

--------------------------------

### GET Register Share (Migrate from Tenor)

Source: https://docs.klipy.com/ai-emoji-api/ai-emojis-trending-api

Registers a share event using the Tenor-compatible API. This endpoint is part of the migration guide and notifies the server of a share.

```APIDOC
## GET Register Share (Migrate from Tenor)

### Description
Registers a share event using the Tenor-compatible API.

### Method
GET

### Endpoint
Register Share

### Parameters
#### Query Parameters
- **id** (string) - Required - The ID of the shared item.

### Response
#### Success Response (200)
- **status** (string) - Success status.

#### Response Example
{
  "status": "success"
}
```

--------------------------------

### GET Posts (Migrate from Tenor)

Source: https://docs.klipy.com/gifs-api/gifs-items-api

Posts endpoint for migrating from Tenor.

```APIDOC
## GET Posts

### Description
Posts endpoint for migrating from Tenor.

### Method
GET

### Endpoint
Posts

### Parameters
No parameters documented.

### Response
No response schema documented.

```

--------------------------------

### GET api/v1/{app_key}/autocomplete/{q}

Source: https://docs.klipy.com/gifs-api/gifs-hide-from-recent

Provides autocomplete suggestions for a given query.

```APIDOC
## [GET] api/v1/{app_key}/autocomplete/{q}

### Description
Provides autocomplete suggestions for a given query.

### Method
GET

### Endpoint
api/v1/{app_key}/autocomplete/{q}

### Parameters
#### Path Parameters
- **app_key** (string) - Required - The application key for authentication.
- **q** (string) - Required - The search query.

#### Query Parameters
- **limit** (integer) - Optional - Maximum number of suggestions to return.

### Response
#### Success Response (200)
- (not specified in source)

#### Response Example
(not specified in source)
```

--------------------------------

### cURL request to get categories

Source: https://docs.klipy.com/migrate-from-tenor/categories

Example cURL command to call the /v2/categories endpoint. Requires an API key in the query parameter. The Content-Type header is set to application/json.

```bash
curl --location 'https://api.klipy.com/v2/categories?key=' \
--header 'Content-Type: application/json'
```

--------------------------------

### GET Search Suggestions (Migrate from Tenor)

Source: https://docs.klipy.com/ai-emoji-api/ai-emojis-trending-api

Retrieves search suggestions using the Tenor-compatible API. This endpoint is part of the migration guide and returns suggested search terms.

```APIDOC
## GET Search Suggestions (Migrate from Tenor)

### Description
Retrieves search suggestions using the Tenor-compatible API.

### Method
GET

### Endpoint
Search Suggestions

### Parameters
#### Query Parameters
- **q** (string) - Required - The search query.

### Response
#### Success Response (200)
- **suggestions** (array) - List of suggested search terms.

#### Response Example
{
  "suggestions": []
}
```

--------------------------------

### GET api/v1/{app_key}/stickers/items

Source: https://docs.klipy.com/gifs-api

Retrieves sticker items by slugs.

```APIDOC
## GET api/v1/{app_key}/stickers/items

### Description
Retrieves sticker items by slugs.

### Method
GET

### Endpoint
api/v1/{app_key}/stickers/items?slugs={value}

### Parameters
#### Path Parameters
- **app_key** (string) - Required - Your application key.

#### Query Parameters
- **slugs** (string) - Required - Comma-separated list of sticker slugs.

```

--------------------------------

### GET /api/v1/{app_key}/stickers/items

Source: https://docs.klipy.com/gifs-api/gifs-items-api

Fetches sticker items by their slugs.

```APIDOC
## GET /api/v1/{app_key}/stickers/items

### Description
Fetches sticker items by their slugs.

### Method
GET

### Endpoint
/api/v1/{app_key}/stickers/items

### Parameters
#### Path Parameters
- **app_key** (string) - Required - The application key for authentication.

#### Query Parameters
- **slugs** (string) - Required - Comma-separated list of sticker slugs.

```

--------------------------------

### GET Trending Search Terms (Migrate from Tenor)

Source: https://docs.klipy.com/ai-emoji-api/ai-emojis-trending-api

Retrieves trending search terms using the Tenor-compatible API. This endpoint is part of the migration guide and returns trending search terms.

```APIDOC
## GET Trending Search Terms (Migrate from Tenor)

### Description
Retrieves trending search terms using the Tenor-compatible API.

### Method
GET

### Endpoint
Trending Search Terms

### Response
#### Success Response (200)
- **terms** (array) - List of trending search terms.

#### Response Example
{
  "terms": []
}
```

--------------------------------

### GET api/v1/{app_key}/autocomplete/{q}

Source: https://docs.klipy.com/gifs-api/gifs-trending-api

Provides autocomplete suggestions for a given query as the user types.

```APIDOC
## GET api/v1/{app_key}/autocomplete/{q}

### Description
Provides autocomplete suggestions for a given query as the user types.

### Method
GET

### Endpoint
api/v1/{app_key}/autocomplete/{q}

### Parameters
#### Path Parameters
- **app_key** (string) - Required - The application key.
- **q** (string) - Required - The partial query.

#### Query Parameters
- **limit** (integer) - Optional - Maximum number of suggestions to return.

### Response
#### Success Response (200)
- **suggestions** (array) - List of autocomplete suggestions.

#### Response Example
{
  "suggestions": ["suggestion1", "suggestion2"]
}
```

--------------------------------

### GET api/v1/{app_key}/search-suggestions/{q}

Source: https://docs.klipy.com/gifs-api/gifs-hide-from-recent

Provides search suggestions for a given query.

```APIDOC
## [GET] api/v1/{app_key}/search-suggestions/{q}

### Description
Provides search suggestions for a given query.

### Method
GET

### Endpoint
api/v1/{app_key}/search-suggestions/{q}

### Parameters
#### Path Parameters
- **app_key** (string) - Required - The application key for authentication.
- **q** (string) - Required - The search query.

#### Query Parameters
- **limit** (integer) - Optional - Maximum number of suggestions to return.

### Response
#### Success Response (200)
- (not specified in source)

#### Response Example
(not specified in source)
```

--------------------------------

### GET api/v1/{app_key}/stickers/items

Source: https://docs.klipy.com/memes-api/memes-items-api

Retrieves sticker items by slugs.

```APIDOC
## GET api/v1/{app_key}/stickers/items

### Description
Retrieves sticker items by slugs.

### Method
GET

### Endpoint
api/v1/{app_key}/stickers/items

### Parameters
#### Path Parameters
- **app_key** (string) - Required - Your application key.

#### Query Parameters
- **slugs** (string) - Required - Comma-separated list of slugs.

```

--------------------------------

### GET api/v1/{app_key}/search-suggestions/{q}

Source: https://docs.klipy.com/gifs-api/gifs-recent-items-api-per-user

Provides search suggestions for a given query.

```APIDOC
## GET api/v1/{app_key}/search-suggestions/{q}

### Description
Provides search suggestions to help users refine their queries or discover related terms.

### Method
GET

### Endpoint
api/v1/{app_key}/search-suggestions/{q}

### Parameters
#### Path Parameters
- **app_key** (string) - Required - Your application key.
- **q** (string) - Required - The search query.

#### Query Parameters
- **limit** (integer) - Optional - Maximum number of suggestions to return.

### Request Example
(No request body)

### Response
#### Success Response (200)
(No response schema documented)

#### Response Example
(No response example documented)
```

--------------------------------

### GET api/v1/{app_key}/stickers/items

Source: https://docs.klipy.com/gifs-api/gifs-trending-api

Fetches sticker items by their slugs.

```APIDOC
## GET api/v1/{app_key}/stickers/items

### Description
Fetches sticker items by their slugs.

### Method
GET

### Endpoint
api/v1/{app_key}/stickers/items

### Parameters
#### Path Parameters
- **app_key** (string) - Required - Your application key.

#### Query Parameters
- **slugs** (string) - Required - Comma-separated list of sticker slugs.

```

--------------------------------

### GET api/v1/{app_key}/search-suggestions/{q}

Source: https://docs.klipy.com/gifs-api/gifs-format-sizes

Provides search suggestions for a given query.

```APIDOC
## GET api/v1/{app_key}/search-suggestions/{q}

### Description
Provides search suggestions to help users refine their queries or discover related terms.

### Method
GET

### Endpoint
api/v1/{app_key}/search-suggestions/{q}

### Parameters
#### Path Parameters
- **app_key** (string) - Required - The application key.
- **q** (string) - Required - The search query.

#### Query Parameters
- **limit** (integer) - Optional - Maximum number of suggestions to return.

### Response
#### Success Response (200)
- **suggestions** (array) - List of suggested terms.

#### Response Example
{
  "suggestions": ["suggestion1", "suggestion2"]
}
```

--------------------------------

### GET Posts

Source: https://docs.klipy.com/migrate-from-tenor/search

Get posts by IDs. This endpoint replaces Tenor's posts endpoint.

```APIDOC
## GET Posts

### Description
Get posts by IDs. This endpoint replaces Tenor's posts endpoint.

### Method
GET

### Endpoint
/posts

### Parameters
#### Query Parameters
- **key** (string) - Required - Your API key.
- **ids** (string) - Required - Comma-separated list of post IDs.
- **limit** (integer) - Optional - Number of results to return.
- **media_filter** (string) - Optional - Comma-separated list of media formats.
- **contentfilter** (string) - Optional - Content filtering level.
- **locale** (string) - Optional - Locale for localized results.
- **country** (string) - Optional - Country code.
- **anon_id** (string) - Optional - Anonymous user ID.
- **ar_range** (string) - Optional - Aspect ratio range.
- **aspect_ratio** (string) - Optional - Aspect ratio filter.

### Response
#### Success Response (200)
- **results** (array) - Array of response objects.

#### Response Example
{
  "results": [
    {
      "id": "example_id",
      "title": "Example Title",
      "media_formats": {},
      "created": 1234567890,
      "content_description": "Example description",
      "itemurl": "https://example.com/item",
      "url": "https://example.com",
      "tags": ["tag1", "tag2"],
      "flags": [],
      "hasaudio": false
    }
  ]
}
```

--------------------------------

### GET api/v1/{app_key}/search-suggestions/{q}

Source: https://docs.klipy.com/gifs-api

Provides search suggestions for a given query.

```APIDOC
## GET api/v1/{app_key}/search-suggestions/{q}

### Description
Provides search suggestions for a query.

### Method
GET

### Endpoint
api/v1/{app_key}/search-suggestions/{q}

### Parameters
#### Path Parameters
- **app_key** (string) - Required - The application key.
- **q** (string) - Required - The search query.

#### Query Parameters
- **limit** (integer) - Optional - Maximum number of suggestions.

```

--------------------------------

### GET /api/v1/{app_key}/stickers/items

Source: https://docs.klipy.com/gifs-api/gifs-search-api

Retrieves sticker items by slugs.

```APIDOC
## GET /api/v1/{app_key}/stickers/items

### Description
Retrieves sticker items by slugs.

### Method
GET

### Endpoint
/api/v1/{app_key}/stickers/items

### Parameters
#### Path Parameters
- **app_key** (string) - Required - The application key.

#### Query Parameters
- **slugs** (string) - Required - The slugs of the stickers.

```

--------------------------------

### GET api/v1/{app_key}/stickers/items

Source: https://docs.klipy.com/

Retrieves specific stickers by slugs.

```APIDOC
## GET api/v1/{app_key}/stickers/items

### Description
Retrieves specific stickers by slugs.

### Method
GET

### Endpoint
api/v1/{app_key}/stickers/items

### Parameters
#### Path Parameters
- **app_key** (string) - Required - Your application key.

#### Query Parameters
- **slugs** (string) - Required - Comma-separated list of sticker slugs.
```

--------------------------------

### GET /api/v1/{app_key}/stickers/items

Source: https://docs.klipy.com/gifs-api/gifs-report-api

Fetches sticker items by slugs.

```APIDOC
## GET /api/v1/{app_key}/stickers/items

### Description
Fetches sticker items by slugs.

### Method
GET

### Endpoint
/api/v1/{app_key}/stickers/items

### Parameters
#### Path Parameters
- **app_key** (string) - Required - The application key.

#### Query Parameters
- **slugs** (string) - Required - Comma-separated list of slugs.

```

--------------------------------

### GET Featured

Source: https://docs.klipy.com/migrate-from-tenor/search

Get featured or trending content. This endpoint replaces Tenor's featured endpoint.

```APIDOC
## GET Featured

### Description
Get featured or trending content. This endpoint replaces Tenor's featured endpoint.

### Method
GET

### Endpoint
/featured

### Parameters
#### Query Parameters
- **key** (string) - Required - Your API key.
- **limit** (integer) - Optional - Number of results to return.
- **pos** (string) - Optional - Position for pagination.
- **contentfilter** (string) - Optional - Content filtering level.
- **media_filter** (string) - Optional - Comma-separated list of media formats.
- **locale** (string) - Optional - Locale for localized results.
- **country** (string) - Optional - Country code.
- **anon_id** (string) - Optional - Anonymous user ID.
- **ar_range** (string) - Optional - Aspect ratio range.
- **aspect_ratio** (string) - Optional - Aspect ratio filter.

### Response
#### Success Response (200)
- **results** (array) - Array of response objects.
- **next** (string) - Pagination cursor.

#### Response Example
{
  "results": [
    {
      "id": "example_id",
      "title": "Example Title",
      "media_formats": {},
      "created": 1234567890,
      "content_description": "Example description",
      "itemurl": "https://example.com/item",
      "url": "https://example.com",
      "tags": ["tag1", "tag2"],
      "flags": [],
      "hasaudio": false
    }
  ],
  "next": "example_cursor"
}
```

--------------------------------

### GET api/v1/{app_key}/search-suggestions/{q}

Source: https://docs.klipy.com/gifs-api/gifs-categories-api

Provides search suggestions for a given query.

```APIDOC
## GET api/v1/{app_key}/search-suggestions/{q}

### Description
Provides search suggestions for a given query.

### Method
GET

### Endpoint
api/v1/{app_key}/search-suggestions/{q}

### Parameters
#### Path Parameters
- **app_key** (string) - Required - The application key.
- **q** (string) - Required - The search query.

#### Query Parameters
- **limit** (integer) - Optional - Maximum number of suggestions to return.

### Response
#### Success Response (200)
- **suggestions** (array) - List of suggestion strings.

#### Response Example
{
  "suggestions": ["suggestion1", "suggestion2"]
}
```

--------------------------------

### GET api/v1/{app_key}/search-suggestions/{q}

Source: https://docs.klipy.com/gifs-api/gifs-share-trigger-api

Provides search suggestions for a given query, with an optional limit.

```APIDOC
## GET api/v1/{app_key}/search-suggestions/{q}

### Description
Provides search suggestions for a query.

### Method
GET

### Endpoint
api/v1/{app_key}/search-suggestions/{q}?limit=10

### Parameters
#### Path Parameters
- **app_key** (string) - Required - The application key.
- **q** (string) - Required - The search query.

#### Query Parameters
- **limit** (integer) - Optional - Maximum number of suggestions (default 10).

### Response
(No response schema documented)

```

--------------------------------

### GET api/v1/{app_key}/autocomplete/{q}

Source: https://docs.klipy.com/gifs-api/gifs-format-sizes

Provides autocomplete suggestions for a query as the user types.

```APIDOC
## GET api/v1/{app_key}/autocomplete/{q}

### Description
Provides autocomplete suggestions to help users complete a query as they type.

### Method
GET

### Endpoint
api/v1/{app_key}/autocomplete/{q}

### Parameters
#### Path Parameters
- **app_key** (string) - Required - The application key.
- **q** (string) - Required - The partial query.

#### Query Parameters
- **limit** (integer) - Optional - Maximum number of suggestions to return.

### Response
#### Success Response (200)
- **suggestions** (array) - List of autocomplete suggestions.

#### Response Example
{
  "suggestions": ["suggestion1", "suggestion2"]
}
```

--------------------------------

### GET api/v1/{app_key}/autocomplete/{q}

Source: https://docs.klipy.com/gifs-api

Provides autocomplete suggestions for a query as the user types.

```APIDOC
## GET api/v1/{app_key}/autocomplete/{q}

### Description
Provides autocomplete suggestions for a query.

### Method
GET

### Endpoint
api/v1/{app_key}/autocomplete/{q}

### Parameters
#### Path Parameters
- **app_key** (string) - Required - The application key.
- **q** (string) - Required - The search query.

#### Query Parameters
- **limit** (integer) - Optional - Maximum number of suggestions.

```

--------------------------------

### GET Search Suggestions

Source: https://docs.klipy.com/migrate-from-tenor/search

Get search suggestions for a query. This endpoint replaces Tenor's search suggestions endpoint.

```APIDOC
## GET Search Suggestions

### Description
Get search suggestions for a query. This endpoint replaces Tenor's search suggestions endpoint.

### Method
GET

### Endpoint
/search_suggestions

### Parameters
#### Query Parameters
- **key** (string) - Required - Your API key.
- **q** (string) - Required - The search query.
- **locale** (string) - Optional - Locale for localized results.
- **country** (string) - Optional - Country code.
- **anon_id** (string) - Optional - Anonymous user ID.

### Response
#### Success Response (200)
- **results** (array) - Array of suggestion strings.

#### Response Example
{
  "results": ["suggestion1", "suggestion2"]
}
```

--------------------------------

### GET api/v1/{app_key}/stickers/items

Source: https://docs.klipy.com/gifs-api/gifs-recent-items-api-per-user

Fetches sticker items by their slugs.

```APIDOC
## GET api/v1/{app_key}/stickers/items

### Description
Fetches sticker items by their slugs.

### Method
GET

### Endpoint
api/v1/{app_key}/stickers/items

### Parameters
#### Path Parameters
- **app_key** (string) - Required - The application key for authentication.

#### Query Parameters
- **slugs** (string) - Required - Comma-separated list of sticker slugs.

```

--------------------------------

### GET /api/v1/{app_key}/stickers/items

Source: https://docs.klipy.com/memes-api/memes-format-sizes

Retrieves sticker items by slugs.

```APIDOC
## GET /api/v1/{app_key}/stickers/items

### Description
Retrieves sticker items by slugs.

### Method
GET

### Endpoint
/api/v1/{app_key}/stickers/items

### Parameters
#### Path Parameters
- **app_key** (string) - Required - Your application key.

#### Query Parameters
- **slugs** (string) - Required - Comma-separated list of slugs.

```

--------------------------------

### GET api/v1/{app_key}/autocomplete/{q}

Source: https://docs.klipy.com/gifs-api/gifs-categories-api

Provides autocomplete suggestions for a query as the user types.

```APIDOC
## GET api/v1/{app_key}/autocomplete/{q}

### Description
Provides autocomplete suggestions for a query as the user types.

### Method
GET

### Endpoint
api/v1/{app_key}/autocomplete/{q}

### Parameters
#### Path Parameters
- **app_key** (string) - Required - The application key.
- **q** (string) - Required - The partial query.

#### Query Parameters
- **limit** (integer) - Optional - Maximum number of suggestions to return.

### Response
#### Success Response (200)
- **suggestions** (array) - List of autocomplete suggestions.

#### Response Example
{
  "suggestions": ["suggestion1", "suggestion2"]
}
```

--------------------------------

### GET api/v1/{app_key}/autocomplete/{q}

Source: https://docs.klipy.com/gifs-api/gifs-recent-items-api-per-user

Provides autocomplete suggestions for a query as the user types.

```APIDOC
## GET api/v1/{app_key}/autocomplete/{q}

### Description
Provides autocomplete suggestions to help users complete a query as they type.

### Method
GET

### Endpoint
api/v1/{app_key}/autocomplete/{q}

### Parameters
#### Path Parameters
- **app_key** (string) - Required - Your application key.
- **q** (string) - Required - The partial query.

#### Query Parameters
- **limit** (integer) - Optional - Maximum number of suggestions to return.

### Request Example
(No request body)

### Response
#### Success Response (200)
(No response schema documented)

#### Response Example
(No response example documented)
```

--------------------------------

### GET api/v1/{app_key}/autocomplete/{q}

Source: https://docs.klipy.com/gifs-api/gifs-items-api

Provides autocomplete suggestions for a query as the user types.

```APIDOC
## GET api/v1/{app_key}/autocomplete/{q}

### Description
Provides autocomplete suggestions for a query.

### Method
GET

### Endpoint
api/v1/{app_key}/autocomplete/{q}

### Parameters
#### Path Parameters
- **app_key** (string) - Required - The application key.
- **q** (string) - Required - The search query.

#### Query Parameters
- **limit** (integer) - Optional - Maximum number of suggestions (default 10).

```

--------------------------------

### GET /api/v1/{app_key}/gifs/categories?locale={country_code}

Source: https://docs.klipy.com/gifs-api/gifs-format-sizes

Retrieves a list of curated GIF categories. Use the app key and locale to get localized categories.

```APIDOC
## GET /api/v1/{app_key}/gifs/categories?locale={country_code}

### Description
Retrieves a list of curated categories that group KLIPY GIFs by common themes, moods, and reactions.

### Method
GET

### Endpoint
/api/v1/{app_key}/gifs/categories?locale={country_code}

### Parameters
#### Path Parameters
- **app_key** (string) - Required - The unique app key issued by KLIPY for your system

#### Query Parameters
- **locale** (string) - Optional - Language of the user in xx_YY format, where: xx is the ISO 639-1 two-letter language code and YY is the ISO 3166-1 alpha-2 two-letter country code

### Response
#### Success Response (200)
- **result** (boolean) - Indicates if the request was successful
- **data** (object) - Contains the response data
  - **locale** (string) - The locale used for the response
  - **categories** (array) - List of categories
    - **category** (string) - The category name
    - **query** (string) - The query string to use with the Search API
    - **preview_url** (string) - URL to a preview GIF for the category

#### Response Example
```json
{
  "result": true,
  "data": {
    "locale": "en_US",
    "categories": [
      {
        "category": "smile",
        "query": "smile",
        "preview_url": "https://static.klipy.com/ii/e293a233a303a98e471f78d04e13a1b0/a5/fd/NnGoLmO8.gif"
      },
      {
        "category": "aww",
        "query": "aww",
        "preview_url": "https://static.klipy.com/ii/925f17378dd1893b674a723c07535afe/1c/24/Oizp49sT.gif"
      },
      {
        "category": "high five",
        "query": "high five",
        "preview_url": "https://static.klipy.com/ii/925f17378dd1893b674a723c07535afe/d9/e6/rtepipfC.gif"
      },
      {
        "category": "good morning",
        "query": "good morning",
        "preview_url": "https://static.klipy.com/ii/ce286d05b8e1a47cd4f32b0e1b6dec0e/a6/f3/SEmLt8aA.gif"
      },
      {
        "category": "good night",
        "query": "good night",
        "preview_url": "https://static.klipy.com/ii/f87f46a2c5aeaeed4c68910815f73eaf/af/77/35MgTkW5.gif"
      }
    ]
  }
}
```

```

--------------------------------

### GET Search (Migrate from Tenor)

Source: https://docs.klipy.com/gifs-api/gifs-items-api

Search endpoint for migrating from Tenor.

```APIDOC
## GET Search

### Description
Search endpoint for migrating from Tenor.

### Method
GET

### Endpoint
Search

### Parameters
No parameters documented.

### Response
No response schema documented.

```