> ## Documentation Index
> Fetch the complete documentation index at: https://docs.socq.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# TikTok 综合搜索

> query 必填，results_limit 默认 100。结果包含视频和图片轮播；region 影响内容可见性，不保证按发布地区筛选。

# TikTok 综合搜索

接口返回异步任务，完成后读取标准结果。

```json theme={"system"}
{
  "query": "coffee",
  "sort_by": "relevance",
  "results_limit": 20
}
```

query 必填，results\_limit 默认 100。结果包含视频和图片轮播；region 影响内容可见性，不保证按发布地区筛选。

## 标准结果字段

任务结果使用下方稳定的 SocQ 字段。系统会统一来源特有的字段名和格式，但不会推断或补充来源未提供的数据。如需缩小返回字段集合，MCP 查询使用 `fields`，Typed 工具使用 `_result_fields`，CLI 使用 `--result-fields`。声明字段的值为 `null` 时仍会保留。

| 字段 | 类型 | 可空 | 说明 |
| - | - | - | - |
| `id` | `string` | 是 | 当前结果项的唯一标识。 |
| `platform` | `string` | 否 | 结果所属的平台，例如 `instagram` 或 `linkedin`。 |
| `resource` | `string` | 否 | 该结果对应的 SocQ 资源，例如 `videos` 或 `comments`。 |
| `type` | `string` | 否 | 结果项的类别，例如 `video`、`post` 或 `comment`。 |
| `url` | `string` | 是 | 结果项的公开访问地址（如可获得）。 |
| `published_at` | `string` | 是 | 源内容的发布时间（如可获得），使用 ISO 8601 格式。 |
| `collected_at` | `string` | 否 | SocQ 采集或处理该结果的时间，使用 ISO 8601 格式。 |
| `text` | `string` | 是 | 视频的说明文字或描述。 |
| `author` | `object` | 是 | 内容的作者或发布者。 |
| `author.id` | `string` | 是 | 作者的唯一标识。 |
| `author.username` | `string` | 是 | 账号的公开用户名或账号标识。 |
| `author.name` | `string` | 是 | 作者的显示名称。 |
| `author.url` | `string` | 是 | 作者的公开访问地址（如可获得）。 |
| `author.avatar_url` | `string` | 是 | 账号头像图片的地址。 |
| `author.is_verified` | `boolean` | 是 | 账号是否已通过平台认证。 |
| `author.is_private` | `boolean` | 是 | 账号是否为私密账号。 |
| `metrics` | `object` | 是 | 结果项可获得的计数和度量数据。 |
| `metrics.likes_count` | `integer` | 是 | 点赞数量。 |
| `metrics.comments_count` | `integer` | 是 | 评论数量。 |
| `metrics.shares_count` | `integer` | 是 | 分享或转发数量。 |
| `metrics.plays_count` | `integer` | 是 | 平台报告的视频播放次数。 |
| `metrics.views_count` | `integer` | 是 | 平台报告的观看数量。 |
| `media` | `array<object>` | 是 | 结果附带的图片、视频或其他媒体。 |
| `media.type` | `string` | 是 | 媒体类型，例如 `image` 或 `video`。 |
| `media.url` | `string` | 是 | 媒体文件的地址。 |
| `media.thumbnail_url` | `string` | 是 | 媒体预览图的地址。 |
| `media.width` | `integer` | 是 | 媒体宽度，单位为像素。 |
| `media.height` | `integer` | 是 | 媒体高度，单位为像素。 |
| `media.duration_seconds` | `number` | 是 | 媒体时长，单位为秒。 |
| `hashtags` | `array<string>` | 是 | 内容关联的话题标签，保留源数据中的拼写。 |
| `mentions` | `array<string>` | 是 | 内容中提及的账号。 |
| `shortcode` | `string` | 是 | 平台用于标识媒体内容的短代码。 |
| `duration_seconds` | `number` | 是 | 时长，单位为秒。 |
| `audio` | `object` | 是 | 视频关联的音频或音乐信息。 |
| `audio.id` | `string` | 是 | 音频或音乐曲目的标识。 |
| `audio.title` | `string` | 是 | 音频或音乐曲目的标题。 |
| `audio.artist` | `string` | 是 | 音频艺术家或创作者名称。 |
| `audio.url` | `string` | 是 | 音频或音乐曲目的地址（如可获得）。 |

以下示例展示任务完成后的响应格式，具体数据以实际查询结果为准。

## 任务完成响应

```json theme={"system"}
{
  "code": 200,
  "data": {
    "task_id": "example-tiktok-top-search",
    "status": "succeeded",
    "public_id": "tiktok/top-search",
    "result_count": 1,
    "credits_amount": 0.7,
    "results": {
      "limit": 50,
      "next_cursor": null,
      "has_more": false,
      "schema_id": "reel-video",
      "schema_version": "1.0",
      "items": [
        {
          "id": "7620673421353012494",
          "platform": "tiktok",
          "resource": "top-search",
          "type": "photo_carousel",
          "url": "https://www.tiktok.com/@creator/photo/7620673421353012494",
          "published_at": "2026-03-24T04:25:45Z",
          "collected_at": "2026-10-13T00:00:00Z",
          "text": "Coffee moments",
          "author": {
            "id": "1",
            "username": "creator",
            "name": "Creator",
            "url": "https://www.tiktok.com/@creator",
            "avatar_url": null,
            "is_verified": null,
            "is_private": null
          },
          "metrics": {
            "likes_count": 2,
            "comments_count": 0,
            "shares_count": null,
            "plays_count": null,
            "views_count": 0
          },
          "media": [
            {
              "type": "image",
              "url": "https://example.com/photo.jpg",
              "thumbnail_url": null,
              "width": 640,
              "height": 814,
              "duration_seconds": null
            }
          ],
          "hashtags": [],
          "mentions": [],
          "shortcode": null,
          "duration_seconds": null,
          "audio": null
        }
      ]
    }
  }
}
```


## OpenAPI

````yaml zh/api-manual/agent-api/agent-api.json POST /v1/tiktok/top-search
openapi: 3.1.0
info:
  title: SocQ Agent API 中文版
  version: v1-050b21a3b206
  description: 根据 SocQ 能力目录生成的异步社交数据 API。
servers:
  - url: https://api.socq.ai
security: []
paths:
  /v1/tiktok/top-search:
    post:
      tags:
        - tiktok
      summary: TikTok 综合搜索
      description: query 必填，results_limit 默认 100。结果包含视频和图片轮播；region 影响内容可见性，不保证按发布地区筛选。
      operationId: socq_tiktok_top_search
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              additionalProperties: false
              properties:
                callback_url:
                  type: string
                  format: uri
                  description: 可选的任务完成回调 URL。
                published_within:
                  type: string
                  minLength: 1
                  enum:
                    - day
                    - month
                    - six_months
                    - three_months
                    - week
                  description: 内容发布时间范围。
                query:
                  type: string
                  minLength: 1
                  description: 搜索关键词。
                region:
                  type: string
                  minLength: 1
                  pattern: ^[A-Za-z]{2}$
                  description: 地区代码。
                results_limit:
                  type: integer
                  minimum: 1
                  maximum: 2000
                  default: 100
                  description: 最多保存的结果数，实际结果可能少于该值。
                sort_by:
                  type: string
                  minLength: 1
                  enum:
                    - date
                    - likes
                    - relevance
                  description: 结果排序方式。
              required:
                - query
              description: >-
                query 必填，results_limit 默认 100。结果包含视频和图片轮播；region
                影响内容可见性，不保证按发布地区筛选。
      responses:
        '200':
          description: 任务已受理
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentSubmitResponse'
        '422':
          description: Input validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentValidationErrorResponse'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    AgentSubmitResponse:
      type: object
      properties:
        code:
          type: integer
          const: 200
          description: HTTP 业务状态码。
        data:
          type: object
          properties:
            task_id:
              type: string
              description: 任务 ID，用于查询任务状态和结果。
            status:
              type: string
              description: 任务当前状态。
            created_time:
              type:
                - string
                - 'null'
              description: 任务创建时间。
          required:
            - task_id
            - status
    AgentValidationErrorResponse:
      type: object
      properties:
        code:
          type: integer
          const: 422
        error:
          type: object
          properties:
            message:
              type: string
            type:
              type: string
            details:
              type: object
          required:
            - message
            - type
      required:
        - code
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: '使用 `Authorization: Bearer <token>` 请求头进行身份验证。'
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: 也可以通过 `x-api-key` 请求头提供 API Key。

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.