Skip to content
Browsabledocs
↑ ↓ to navigate · Enter to openQuick links
Staging API reference · Requests use https://api-ingress-worker-staging.browsable-staging.workers.dev
Documentation YouTube video comments
Markdown ↗
YouTube APIs

YouTube video comments

Fetch top-level comments for a YouTube video using the public watch page and comments continuations.

POST/v1/youtube/video/comments
Authenticate every request

Send Authorization: Bearer YOUR_API_KEY. Get an API key →

Parameters

Send these fields in a flat JSON body. Add _run to choose execution options.

Provide at least one of: video_url; video_id.

urlstringOptional

YouTube video URL, short URL, or shorts URL. Preferred name; video_url remains supported.

pagesintegerOptional

Number of comment pages to fetch (1-20). Default: 1. Minimum: 1. Maximum: 20.

video_idstringOptional

YouTube video ID.

Advanced & compatibility inputs 1
video_urlstringOptional

YouTube video URL, short URL, or shorts URL. You can also use url.

Response

Every response describes a run. Read result once run_status is succeeded.

run_id
The run to track. Keep it when contacting support.
run_status
Queued, running, waiting for sign-in, succeeded, or failed. Check this even after an HTTP 200.
status_url
Poll this URL while the run is pending. Keep the same run instead of starting another request.
result
The endpoint’s returned data. The example is illustrative; actual fields may be empty or unavailable.
error
On failure, inspect its code, message, retryable and action fields.
View the complete output schema
JSON
{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "success",
    "pages_requested",
    "pages_fetched",
    "count",
    "comments",
    "pagination"
  ],
  "properties": {
    "count": {
      "type": "number"
    },
    "success": {
      "type": "boolean"
    },
    "comments": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "page"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "page": {
            "type": "number"
          },
          "text": {
            "type": "string"
          },
          "is_pinned": {
            "type": "boolean"
          },
          "author_url": {
            "type": "string"
          },
          "is_hearted": {
            "type": "boolean"
          },
          "like_count": {
            "type": "number"
          },
          "author_name": {
            "type": "string"
          },
          "reply_count": {
            "type": "number"
          },
          "published_time": {
            "type": "string"
          },
          "like_count_text": {
            "type": "string"
          },
          "author_thumbnail_url": {
            "type": "string"
          }
        },
        "additionalProperties": true
      }
    },
    "pagination": {
      "type": "object",
      "required": [
        "has_next_page",
        "next_continuation"
      ],
      "properties": {
        "has_next_page": {
          "type": "boolean"
        },
        "next_continuation": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "additionalProperties": false
    },
    "pages_fetched": {
      "type": "number"
    },
    "pages_requested": {
      "type": "number"
    }
  },
  "additionalProperties": true
}
View a polled run response
JSON
{
  "run_id": "00000000-0000-4000-8000-000000000001",
  "task_key": "youtube-video-comments",
  "task_name": "YouTube video comments",
  "run_status": "succeeded",
  "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001",
  "result": {
    "count": 1,
    "success": true,
    "comments": [
      {
        "id": "id-1",
        "page": 1,
        "text": "Sample text 1",
        "is_pinned": true,
        "author_url": "https://example.com/item-1",
        "is_hearted": true,
        "like_count": 1,
        "author_name": "Stylish Shoreditch Loft with Balcony",
        "reply_count": 1,
        "published_time": "sample",
        "like_count_text": "Sample like_count_text 1",
        "author_thumbnail_url": "https://images.example.com/author_thumbnail_url-1.jpg"
      }
    ],
    "pagination": {
      "has_next_page": true,
      "next_continuation": "sample"
    },
    "pages_fetched": 1,
    "pages_requested": 1
  },
  "error": null
}

Errors & retries

  • 400Fix the fields listed in errors before retrying.
  • 428Connect the requested website account using the returned sign-in link.
  • 429Wait for the duration in Retry-After.
  • 5xxRetry transient failures with backoff. Keep the request ID.

A failed run has its own error inside the response. Retry it only when error.retryable is true.

Validation, pagination and recovery →

More examples

Async request with polling
RUN=$(curl -s -X POST "https://api-ingress-worker-staging.browsable-staging.workers.dev/v1/youtube/video/comments" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"video_url":"https://example.com/item-1"}')

RUN_ID=$(echo "$RUN" | jq -er '.run_id // empty') || { echo "$RUN" >&2; exit 1; }
POLL_DELAY=3

while true; do
  RESULT=$(curl -s -H "Authorization: Bearer YOUR_API_KEY" "https://api-ingress-worker-staging.browsable-staging.workers.dev/v1/runs/$RUN_ID")
  STATUS=$(echo "$RESULT" | jq -r '.run_status')
  if [[ "$STATUS" =~ ^(succeeded|failed|errored|cancelled|canceled|expired)$ ]]; then
    echo "$RESULT"
    break
  fi
  sleep "$(awk "BEGIN { print $POLL_DELAY * (0.9 + ($RANDOM % 21) / 100) }")"
  POLL_DELAY=$((POLL_DELAY < 30 ? POLL_DELAY * 2 : 30))
  [ "$POLL_DELAY" -gt 30 ] && POLL_DELAY=30
done
Wait-for-results request
curl -X POST "https://api-ingress-worker-staging.browsable-staging.workers.dev/v1/youtube/video/comments" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"video_url":"https://example.com/item-1","_run":{"async":false}}'
Canonical & compatibility routes

You can also send the same JSON body to /v1/tasks/youtube-video-comments/runs.