Schema preview Draft
Comment schema (draft)
A public comment or reply on a post, with its author, thread position and like/reply counts.
Draft: not yet available. No endpoint returns comments yet. This schema may change before the first endpoint ships; don't build against it.
Draft schema
When comment endpoints ship, they will return objects shaped like this as data, next to the standard meta, the same on every platform.
| Field | Type | Description |
|---|---|---|
platform | string | Platform ID (tiktok, youtube, …). |
id | string | Platform-native comment ID (string; Reddit without t1_). |
post_id | string | ID of the post commented on (equals post.id). |
parent_id | string or null | ID of the comment this replies to; null for top-level comments. |
url | string (uri) or null | Permalink, when the platform has one. |
text | string | Comment body as plain text. |
author | object | The commenting account. |
author.id | string or null | Platform-native account ID; null when only the handle is known. |
author.username | string or null | Handle without the @; null when the account has none. |
author.display_name | string or null | Display name shown on the profile. |
author.url | string (uri) or null | Canonical profile URL. |
author.avatar_url | string (uri) or null | Profile picture URL. Platform CDN URLs can expire within hours. |
author.is_verified | boolean or null | Platform verification badge; null where the platform has no badge. |
published_at | string (date-time) or null | When the comment was posted, RFC 3339 UTC (relative on some platforms: see approximate_fields). |
edited_at | string (date-time) or null | When the comment was last edited, RFC 3339 UTC. |
is_pinned | boolean or null | Pinned by the post's author. |
is_liked_by_author | boolean or null | Liked or hearted by the post's author. |
metrics | object | Counts at fetch time; null = hidden or not exposed, 0 = zero. |
metrics.like_count | integer or null | Likes or upvotes; never negative. |
metrics.reply_count | integer or null | Direct replies. |
approximate_fields | string[] | JSON paths of values rounded by the platform or parsed from display text; [] when all exact. |
Item errors
Planned item-level errors, besides the request-level errors:
| Code | HTTP | Retry | Meaning | What to do |
|---|---|---|---|---|
not_found | 404 | No | The item does not exist or was deleted. | Check the URL or ID; do not retry. |
private_or_unavailable | 403 | No | The item exists but is private, age- or region-gated, or requires a login to view. | Only public items can be fetched; do not retry. |