Skip to content

SEARCH_STICKER API Documentation ​

🌐 Language Switch ​

中文版 | English

Interface Information ​

POST /openapi/capcut-mate/v1/search_sticker

Function Description ​

Search stickers by keywords. This interface is used to search for related sticker materials based on keywords provided by users, returning a list of matching stickers, including detailed information such as image URLs, dimensions, types, etc.

Request Parameters ​

json
{
  "keyword": "人"
}

Parameter Description ​

ParameterTypeRequiredDefaultDescription
keywordstring✅-Search keyword

Parameter Details ​

keyword ​

  • Type: string
  • Description: Keyword to search for stickers
  • Example: "人", "花", "动物"

Response Format ​

Success Response (200) ​

json
{
  "code": 0,
  "message": "success",
  "data": [
    {
      "title": "大笑",
      "sticker_id": "7521200021564427545",
      "image_url": "https://p3-heycan-jy-sign.byteimg.com/tos-cn-i-3jr8j4ixpe/29351205dbd943658d94c8feb17e5ed4~tplv-3jr8j4ixpe-resize:1920:1920.png?x-expires=1797257777&x-signature=r18I9uLQzgm%2FcvF8WNLbgw8BRwg%3D"
    }
  ]
}

Response Field Description ​

FieldTypeDescription
dataarraySticker data list
titlestringSticker title (the only search key)
sticker_idstringSticker ID, the input for add_sticker
image_urlstringSticker preview image URL (1920×1920)

Earlier versions also returned sticker.large_image, sticker.track_thumbnail, sticker.sticker_package, sticker.sticker_type and sticker.preview_cover. These have been removed: preview_cover is an empty string in every entry, and the rest are read by no code. The response is now flat instead of nested, so callers must be updated accordingly.

Error Response ​

json
{
  "code": 1001,
  "message": "Parameter validation failed"
}

Usage Examples ​

cURL Examples ​

1. Search Stickers with Keyword "人" ​

bash
curl -X POST https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/search_sticker \
  -H "Content-Type: application/json" \
  -d '{
    "keyword": "人"
  }'

2. Search Stickers with Keyword "动物" ​

bash
curl -X POST https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/search_sticker \
  -H "Content-Type: application/json" \
  -d '{
    "keyword": "动物"
  }'

Error Code Description ​

Error CodeError MessageDescriptionSolution
1001Parameter validation failedkeyword is missing (request body failed schema validation)Provide a valid keyword parameter

Notes ​

  1. Keyword Matching: Current implementation uses simple title matching, can be extended to full-text search in actual applications
  2. Data Source: Currently returns mock data, in actual applications should connect to sticker database or call external APIs
  3. Performance Consideration: For large sticker datasets, should consider pagination and caching mechanisms

Workflow ​

  1. Validate required parameter (keyword)
  2. Call service layer to search for stickers
  3. Return matching sticker list