> ## 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.

# Reddit 版内搜索

> 在指定的单个 subreddit 社区内搜索公开讨论与帖子。

# Reddit 版内搜索

在指定的单个 subreddit 社区内按关键词、时间范围和排序方式搜索公开讨论与帖子。

```json theme={"system"}
{
  "query": "AI agents",
  "urls": [
    "https://www.reddit.com/r/technology/"
  ],
  "results_limit": 20,
  "sort_by": "relevance",
  "published_within": "all"
}
```

## 通过 MCP 使用

| 接口          | 值                                                        |
| ----------- | -------------------------------------------------------- |
| REST        | `POST /v1/reddit/subreddit-search`                       |
| Compact MCP | `socq_execute`，并设置 `endpoint: "reddit/subreddit-search"` |
| 类型化 MCP     | `socq_reddit_subreddit_search`                           |
| 精确工具 URL    | `https://api.socq.ai/mcp?tools=reddit_subreddit_search`  |
| CLI         | `socq reddit subreddit-search`                           |

使用 `socq_execute` 时，将上面的 JSON 请求体作为 `input` 对象传入；也可以将相同字段直接传给类型化 MCP 工具。类型化 MCP 工具还支持 `_wait_seconds`、`_result_limit` 和 `_idempotency_key`。

<Info>
  提交成功后会返回 `task_id`。继续调用 `socq_get_task` 直到任务成功，然后从 `results.items` 读取标准化记录。
</Info>

完整的提交和轮询流程请参阅 [MCP 快速开始](/zh/integrations/mcp)。

## 结果字段

任务结果使用下方稳定的 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.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>` | 是  | 内容中提及的账号。                                |

## 任务完成响应

```json theme={"system"}
{
  "code": 200,
  "data": {
    "task_id": "A1B2C3D4E5F6G7H8",
    "status": "succeeded",
    "public_id": "reddit/subreddit-search",
    "result_count": 1,
    "credits_amount": 0.6,
    "results": {
      "limit": 1,
      "next_cursor": null,
      "has_more": false,
      "schema_id": "post",
      "schema_version": "1.0",
      "items": [
        {
          "id": "1wczhox",
          "platform": "reddit",
          "resource": "subreddit-search",
          "type": "post",
          "url": "https://www.reddit.com/r/technology/comments/1wczhox/anthropic_reveals_rogue_ai_agents_hate_captchas/",
          "published_at": "2026-09-10T23:32:01Z",
          "collected_at": "2026-09-12T07:00:00Z",
          "text": "Anthropic reveals rogue AI agents hate CAPTCHAs, just like you",
          "author": {
            "id": "t2_6w1qkho3y",
            "username": "TylerFortier_Photo",
            "name": "TylerFortier_Photo",
            "url": null,
            "avatar_url": null,
            "is_verified": null,
            "is_private": null
          },
          "metrics": {
            "likes_count": null,
            "comments_count": 98,
            "shares_count": null,
            "views_count": null
          },
          "media": [],
          "hashtags": null,
          "mentions": null
        }
      ]
    }
  }
}
```


## OpenAPI

````yaml zh/api-manual/agent-api/agent-api.json POST /v1/reddit/subreddit-search
openapi: 3.1.0
info:
  title: SocQ Agent API 中文版
  version: v1-c801a6d1844b
  description: 根据 SocQ 能力目录生成的异步社交数据 API。
servers:
  - url: https://api.socq.ai
security: []
paths:
  /v1/reddit/subreddit-search:
    post:
      tags:
        - reddit
      summary: Reddit 版内搜索
      description: 在指定的单个 subreddit 社区内搜索公开讨论与帖子。
      operationId: socq_reddit_subreddit_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:
                    - all
                    - day
                    - hour
                    - month
                    - week
                    - year
                  description: 内容发布时间范围。
                query:
                  type: string
                  minLength: 1
                  description: 搜索关键词。
                results_limit:
                  type: integer
                  minimum: 1
                  maximum: 2000
                  default: 100
                  description: 最多保存的结果数，实际结果可能少于该值。
                sort_by:
                  type: string
                  minLength: 1
                  enum:
                    - comments
                    - hot
                    - new
                    - relevance
                    - top
                  description: 结果排序方式。
                urls:
                  type: array
                  items:
                    type: string
                    minLength: 1
                  description: 公开内容、主页或商品 URL 列表。每个 URL 分别应用结果数量上限，至少提供 1 项。
              required:
                - query
                - urls
      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。

````