# SEARCH_STICKER API 接口文档 ## 🌐 语言切换 [中文版](./search_sticker.zh.md) | [English](./search_sticker.md) ## 接口信息 ``` POST /openapi/capcut-mate/v1/search_sticker ``` ## 功能描述 根据关键词搜索贴纸。该接口用于根据用户提供的关键词搜索相关的贴纸素材,返回匹配的贴纸列表,包括贴纸的详细信息如图片URL、尺寸、类型等。 ## 请求参数 ```json { "keyword": "人" } ``` ### 参数说明 | 参数名 | 类型 | 必填 | 默认值 | 说明 | |--------|------|------|--------|------| | keyword | string | ✅ | - | 搜索关键词 | ### 参数详解 #### keyword - **类型**: string - **说明**: 搜索贴纸的关键词 - **示例**: "人", "花", "动物" ## 响应格式 ### 成功响应 (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" } ] } ``` ### 响应字段说明 | 字段名 | 类型 | 说明 | |--------|------|------| | data | array | 贴纸数据列表 | | title | string | 贴纸标题(唯一的搜索键) | | sticker_id | string | 贴纸ID,`add_sticker` 的入参 | | image_url | string | 贴纸预览图URL(1920×1920) | > 早期版本还返回 `sticker.large_image`、`sticker.track_thumbnail`、`sticker.sticker_package`、`sticker.sticker_type`、`sticker.preview_cover` 等字段,现已移除:`preview_cover` 在全部条目中均为空串,其余字段无任何代码读取。响应结构由嵌套改为扁平,请调用方相应调整。 ### 错误响应 ```json { "code": 1001, "message": "参数校验失败" } ``` ## 使用示例 ### cURL 示例 #### 1. 搜索关键词为"人"的贴纸 ```bash curl -X POST https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/search_sticker \ -H "Content-Type: application/json" \ -d '{ "keyword": "人" }' ``` #### 2. 搜索关键词为"动物"的贴纸 ```bash curl -X POST https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/search_sticker \ -H "Content-Type: application/json" \ -d '{ "keyword": "动物" }' ``` ## 错误码说明 | 错误码 | 错误信息 | 说明 | 解决方案 | |--------|----------|------|----------| | 1001 | 参数校验失败 | 缺少 keyword 参数(请求体未通过参数校验) | 提供有效的keyword参数 | ## 注意事项 1. **关键词匹配**: 当前实现为简单的标题匹配,实际应用中可以扩展为全文搜索 2. **数据来源**: 当前返回的是模拟数据,实际应用中应该连接贴纸数据库或调用外部API 3. **性能考虑**: 对于大量贴纸数据,应考虑分页和缓存机制 ## 工作流程 1. 验证必填参数(keyword) 2. 调用服务层搜索贴纸 3. 返回匹配的贴纸列表 ## 相关接口 - [添加贴纸](./add_sticker.md) - [创建草稿](./create_draft.md) ---