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

# Twitch User Videos

> 获取 Twitch 的标准化公开 User Videos 数据。

# Twitch User Videos

获取 Twitch 的标准化公开 User Videos 数据。

每个成功任务固定扣除 `0.19` 积分。

## 请求体

```json theme={"system"}
{
  "username": "ninja",
  "filter_by": "all",
  "sort_by": "time"
}
```

## 通过 MCP 使用

| 接口             | 值                                                    |
| -------------- | ---------------------------------------------------- |
| REST           | `POST /v1/twitch/user-videos`                        |
| Compact MCP    | `socq_execute` with `endpoint: "twitch/user-videos"` |
| Typed MCP      | `socq_twitch_user_videos`                            |
| Exact-tool URL | `https://api.socq.ai/mcp?tools=twitch_user_videos`   |
| CLI            | `socq twitch user-videos`                            |

<Info>
  请求成功后会返回 `task_id`。使用 `socq_get_task` 查询任务，成功后从 `results.items` 读取标准化结果。
</Info>

## 结果字段

| 字段                       | 类型              | 可为空 | 说明                                       |
| ------------------------ | --------------- | --- | ---------------------------------------- |
| `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`                 | `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`                | `object`        | 否   | 标准结果中的字段值。                               |
| `metrics.likes_count`    | `integer`       | 是   | 点赞数量。                                    |
| `metrics.comments_count` | `integer`       | 是   | 评论数量。                                    |
| `metrics.shares_count`   | `integer`       | 是   | 分享或转发数量。                                 |
| `metrics.plays_count`    | `integer`       | 是   | 平台报告的视频播放次数。                             |
| `metrics.views_count`    | `integer`       | 是   | 平台报告的观看数量。                               |
| `media`                  | `array<object>` | 是   | 结果附带的图片、视频或其他媒体。                         |
| `hashtags`               | `array<string>` | 是   | 内容关联的话题标签，保留源数据中的拼写。                     |
| `mentions`               | `array<string>` | 是   | 内容中提及的账号。                                |
| `shortcode`              | `string`        | 是   | 平台用于标识媒体内容的短代码。                          |
| `duration_seconds`       | `number`        | 是   | 时长，单位为秒。                                 |
| `audio`                  | `object`        | 是   | 视频关联的音频或音乐信息。                            |
| `audio`                  | `object`        | 否   | 标准结果中的字段值。                               |
| `audio.id`               | `string`        | 是   | 音频或音乐曲目的标识。                              |
| `audio.title`            | `string`        | 是   | 音频或音乐曲目的标题。                              |
| `audio.artist`           | `string`        | 是   | 音频艺术家或创作者名称。                             |
| `audio.url`              | `string`        | 是   | 音频或音乐曲目的地址（如可获得）。                        |

## 任务完成响应

```json theme={"system"}
{
  "code": 200,
  "message": "success",
  "data": {
    "task_id": "task_example",
    "public_id": "twitch/user-videos",
    "status": "succeeded",
    "result_count": 0,
    "credits_amount": 0,
    "results": {
      "schema_id": "reel-video",
      "schema_version": "1.0",
      "items": [],
      "limit": 20,
      "next_cursor": null,
      "has_more": false
    }
  }
}
```


## OpenAPI

````yaml zh/api-manual/agent-api/agent-api.json POST /v1/twitch/user-videos
openapi: 3.1.0
info:
  title: SocQ Agent API 中文版
  version: v1-d93e6d4f8368
  description: 根据 SocQ 能力目录生成的异步社交数据 API。
servers:
  - url: https://api.socq.ai
security: []
paths:
  /v1/twitch/user-videos:
    post:
      tags:
        - twitch
      summary: Twitch User Videos
      description: 获取 Twitch 的标准化公开 User Videos 数据。
      operationId: socq_twitch_user_videos
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              additionalProperties: false
              properties:
                filter_by:
                  type: string
                  minLength: 1
                  enum:
                    - all
                    - archive
                    - archives
                    - highlight
                    - highlights
                    - upload
                    - uploads
                  description: 请求参数。
                sort_by:
                  type: string
                  minLength: 1
                  enum:
                    - time
                    - views
                  description: 结果排序方式。
                username:
                  type: string
                  minLength: 1
                  description: 公开账号用户名。
              required:
                - username
      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。

````