Search gifs
Returns search gifs for the authorised account.
/api/v1/messaging/gifs/searchmessaging: read1,000 requests/minute/key · all plansActive API keys: Free 1, Pro 5, Pro+ 5. The request rate is the same on every plan.
Parameters
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
query | string | Required | Filter or option: query. Minimum length: 1. Maximum length: 100. |
limit | integer | Optional | Filter or option: limit. Minimum: 1. Maximum: 30. |
cursor | string | Optional | Filter or option: cursor. Maximum length: 128. |
contentFilter | string | Optional | Filter or option: content filter. Allowed values: "off", "low", "medium", "high". |
locale | string | Optional | Filter or option: locale. Maximum length: 16. |
Behaviour and pagination
Omit cursor for the first page. Pass the nextCursor value from the response into the next request; if nextCursor is an object, use its index property. A null nextCursor indicates the end.
Response schema
200
Successful response.
| Name | Type | Required | Description |
|---|---|---|---|
items | array<object> | Required | Items returned by this request. |
items[].provider | string | Required | Provider. Allowed values: "tenor", "giphy". |
items[].providerGifId | string | Required | Provider Gif Id. |
items[].title | string | Optional | Display title. |
items[].description | string | Optional | Description of the resource. |
items[].previewUrl | string | Required | Preview Url. |
items[].mediaUrl | string | Required | Media Url. |
items[].tinyUrl | string | Optional | Tiny Url. |
items[].width | number | Optional | Width. |
items[].height | number | Optional | Height. |
items[].duration | number | Optional | Duration. |
items[].contentDescription | string | Optional | Content Description. |
items[].sourceUrl | string | Optional | Source Url. |
nextCursor | null | string | Required | Cursor for the next page; null when there are no further results. |
configured | boolean | Required | Configured. |
providerGifs | array<JSON value> | Optional | Provider Gifs. Native GIPHY SDK payloads for |
Errors
400· JSON errorRequest failed (BAD_REQUEST).
401· JSON errorMissing or invalid API key. Use Authorization: Bearer <token>.
403· JSON errorRequires messaging: read; ownership or feature restrictions may also deny access.
404· JSON errorRequest failed (NOT_FOUND).
409· JSON errorconflict.
429· JSON errorAPI rate limit exceeded (1000 requests per minute). Retry shortly.
500· JSON errorinternal server error.
503· JSON errorObject storage is not configured. Set MinIO (or compatible S3) env vars to upload files.
Request example
Set FLORALITY_KEY in your environment. These examples use demo identifiers.
curl --request GET 'https://floralitys.com/api/v1/messaging/gifs/search?query=demo' \
--header "Authorization: Bearer $FLORALITY_KEY"Responses
Successful response.
{
"items": [
{
"provider": "tenor",
"providerGifId": "11111111-1111-4111-8111-111111111111",
"title": "River",
"description": "A note from our demo system.",
"previewUrl": "https://example.com/demo",
"mediaUrl": "https://example.com/demo",
"tinyUrl": "https://example.com/demo",
"width": 0,
"height": 0,
"duration": 0,
"contentDescription": "A note from our demo system.",
"sourceUrl": "https://example.com/demo"
}
],
"nextCursor": null,
"configured": false,
"providerGifs": [
{}
]
}Example values are illustrative demo data.