Skip to main content
GET
Get video comments

Authorizations

Authorization
string
header
required

Permanent personal API key created in the dashboard. Example: curl -H "Authorization: Bearer aty_…" https://your-host/v1/projects

Path Parameters

id
string
required

Provider video ID.

Minimum string length: 1
Example:

"dQw4w9WgXcQ"

Query Parameters

provider
enum<string>
required

External video provider.

Available options:
youtube
Example:

"youtube"

retain
boolean
default:false

Browser-session only. Include a signed receipt for retaining this exact page. Not supported with all=true.

refresh
boolean
default:false

Fetch again and save a new version. Default reuses saved data regardless of age. A failed explicit refresh returns an error.

continuation
string

Opaque pagination token.

all
boolean
default:false

Fetch up to five newest-first pages, about 100 comments, rather than one provider-default-ranked page. A crawl that reaches the limit returns what it collected with meta.partial set. Use continuation to page further.

Response

A comment page or collection.

videoId
string
required
comments
object[]
required
meta
object
required
pageReceipt
string

Account-bound receipt for this exact stored page, returned only for a browser-session retain=true request.

Pattern: ^v1\.[a-f0-9]{64}\.[a-f0-9]{64}$
totalCount
integer

Total comments reported by YouTube when available.

Required range: x >= 0
continuation
string
complete
boolean
pagesFetched
integer
topLevelCount
integer
replyCount
integer
remainingContinuations
integer