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

# YouTube Related Videos

> Collect the videos YouTube recommends next to a video.

# YouTube Related Videos

Get the list YouTube places beside a video as what to watch next: titles, channels, view counts and thumbnails. Run it on your own uploads or a competitor's to see which videos and channels YouTube treats as their neighbours — the company a video keeps in recommendations.

```json theme={"dark"}
{
  "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
}
```

url is required: a watch, youtu.be, Shorts or live link. One run returns the whole recommendation list, usually about 20 videos, billed per video.

## Standard Result Fields

Task results use the stable SocQ fields below. Source-specific field names and formats are normalized without inferring or enriching values that the source did not provide. To request a smaller field set, use `fields` for MCP queries, `_result_fields` for typed tools, or `--result-fields` in the CLI. Declared fields remain present when their value is `null`.

| Field | Type | Nullable | Description |
| - | - | - | - |
| `id` | `string` | Yes | Unique identifier for this result item. |
| `platform` | `string` | No | Platform the result belongs to, such as `instagram` or `linkedin`. |
| `resource` | `string` | No | SocQ resource represented by the result, such as `videos` or `comments`. |
| `type` | `string` | No | Category of the result item, such as `video`, `post`, or `comment`. |
| `url` | `string` | Yes | Public URL of the result item when available. |
| `published_at` | `string` | Yes | Time the source item was published, in ISO 8601 format when available. |
| `collected_at` | `string` | No | Time SocQ collected or processed this result, in ISO 8601 format. |
| `text` | `string` | Yes | Video caption or description. |
| `author` | `object` | Yes | Author or publisher of the content. |
| `author.id` | `string` | Yes | Unique identifier of the author. |
| `author.username` | `string` | Yes | Public username or handle of the account. |
| `author.name` | `string` | Yes | Display name of the author. |
| `author.url` | `string` | Yes | Public URL of the author when available. |
| `author.avatar_url` | `string` | Yes | URL of the account avatar image. |
| `author.is_verified` | `boolean` | Yes | Whether the account is verified on the platform. |
| `author.is_private` | `boolean` | Yes | Whether the account is private. |
| `metrics` | `object` | Yes | Counters and measurements available for the result item. |
| `metrics.likes_count` | `integer` | Yes | Number of likes. |
| `metrics.comments_count` | `integer` | Yes | Number of comments. |
| `metrics.shares_count` | `integer` | Yes | Number of shares or reposts. |
| `metrics.plays_count` | `integer` | Yes | Number of video playback starts reported by the platform. |
| `metrics.views_count` | `integer` | Yes | Number of views reported by the platform. |
| `media` | `array<object>` | Yes | Images, videos, or other media attached to the result. |
| `media.type` | `string` | Yes | Media kind, such as `image` or `video`. |
| `media.url` | `string` | Yes | URL of the media asset. |
| `media.thumbnail_url` | `string` | Yes | URL of the media preview image. |
| `media.width` | `integer` | Yes | Media width in pixels. |
| `media.height` | `integer` | Yes | Media height in pixels. |
| `media.duration_seconds` | `number` | Yes | Media duration in seconds. |
| `hashtags` | `array<string>` | Yes | Hashtags associated with the content, without changing their source spelling. |
| `mentions` | `array<string>` | Yes | Accounts mentioned in the content. |
| `shortcode` | `string` | Yes | Platform shortcode used to identify the media item. |
| `duration_seconds` | `number` | Yes | Duration in seconds. |
| `audio` | `object` | Yes | Audio or music metadata associated with the video. |
| `audio.id` | `string` | Yes | Identifier of the audio or music track. |
| `audio.title` | `string` | Yes | Title of the audio or music track. |
| `audio.artist` | `string` | Yes | Name of the audio artist or creator. |
| `audio.url` | `string` | Yes | URL of the audio or music track when available. |

The following example shows the response format for a completed task. Actual data depends on your query.

## Completed Task Response

```json theme={"dark"}
{
  "code": 200,
  "data": {
    "task_id": "example-youtube-related-videos",
    "status": "succeeded",
    "public_id": "youtube/related-videos",
    "result_count": 1,
    "credits_amount": 0.5,
    "results": {
      "limit": 50,
      "next_cursor": null,
      "has_more": false,
      "schema_id": "reel-video",
      "schema_version": "1.0",
      "items": [
        {
          "id": "yPYZpwSpKmA",
          "platform": "youtube",
          "resource": "related-videos",
          "type": "video",
          "url": "https://www.youtube.com/watch?v=yPYZpwSpKmA",
          "published_at": null,
          "collected_at": "2026-11-09T11:13:32Z",
          "text": "Rick Astley - Together Forever (Official Video)",
          "author": {
            "id": "UCuAXFkgsw1L7xaCfnd5JJOw",
            "username": null,
            "name": "Rick Astley",
            "url": "https://www.youtube.com/channel/UCuAXFkgsw1L7xaCfnd5JJOw",
            "avatar_url": null,
            "is_verified": null,
            "is_private": null
          },
          "metrics": {
            "likes_count": null,
            "comments_count": null,
            "shares_count": null,
            "plays_count": null,
            "views_count": 160000000
          },
          "media": [
            {
              "type": "image",
              "url": "https://i.ytimg.com/vi/yPYZpwSpKmA/hqdefault.jpg",
              "thumbnail_url": "https://i.ytimg.com/vi/yPYZpwSpKmA/hqdefault.jpg",
              "width": 336,
              "height": 188,
              "duration_seconds": null
            }
          ],
          "hashtags": null,
          "mentions": null,
          "shortcode": null,
          "duration_seconds": null,
          "audio": null
        }
      ]
    }
  }
}
```


## OpenAPI

````yaml api-manual/agent-api/agent-api.json POST /v1/youtube/related-videos
openapi: 3.1.0
info:
  title: SocQ Agent API
  version: v1-1fa58609f514
  description: Asynchronous social data API generated from the SocQ Capability Registry.
servers:
  - url: https://api.socq.ai
security: []
paths:
  /v1/youtube/related-videos:
    post:
      tags:
        - youtube
      summary: YouTube Related Videos API
      description: Collect the videos YouTube recommends next to a video.
      operationId: socq_youtube_related_videos
      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
                url:
                  type: string
                  minLength: 1
                  description: >-
                    YouTube video or Shorts URL, such as
                    https://www.youtube.com/watch?v=dQw4w9WgXcQ
              required:
                - url
              description: >-
                url is required. Returns the videos YouTube recommends next to
                that video, usually about 20.
      responses:
        '200':
          description: Task accepted
          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
        data:
          type: object
          properties:
            task_id:
              type: string
            status:
              type: string
            created_time:
              type:
                - string
                - 'null'
          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
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````

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