StatusSupportGet API keyDashboard
SchemasComments

Schemas

Comment

Use with AI

Public comments and replies with their author, text, place in the thread, and like and reply counts.

Endpoints

15 endpoints return comments on Bluesky, Facebook, Instagram, Reddit, Rumble, Snapchat, Threads, TikTok and YouTube.

Schema

Single-item endpoints return this object as data; list endpoints return an array of them as data with a page object. The standard meta comes with every response.

platformstring

Platform ID (tiktok, youtube, …).

idstring

Platform-native comment ID (string; Reddit with its t1_ prefix).

post_idstring

ID of the post commented on (equals post.id).

parent_idstringnullable

ID of the comment this replies to; null for top-level comments.

urlstring urinullable

Permalink, when the platform has one.

textstring

Comment body as plain text.

authorobject

The commenting account. An account the platform no longer names (a deleted account) has a null id and username and the platform's label as display_name (Reddit: [deleted]).

ShowHide 6 child fields
idstringnullable

Platform-native account ID; null when only the handle is known.

usernamestringnullable

Handle without the @; null when the account has none.

display_namestringnullable

Display name shown on the profile.

urlstring urinullable

Canonical profile URL.

avatar_urlstring urinullable

Profile picture URL. Platform CDN URLs can expire within hours.

is_verifiedbooleannullable

Platform verification badge; null where the platform has no badge.

published_atstring date-timenullable

When the comment was posted, RFC 3339 UTC. Where the platform shows only a relative time ("3 weeks ago"), the latest time that label allows (the fetch time minus the stated amount), listed in approximate_fields.

edited_atstring date-timenullable

When the comment was last edited, RFC 3339 UTC; null when never edited or when the platform marks edits without a time (see is_edited).

is_editedbooleannullable

The comment was edited after posting (the platform's edited mark); null when the platform does not say.

is_pinnedbooleannullable

Pinned by the post's author.

is_liked_by_authorbooleannullable

Liked or hearted by the post's author.

is_by_post_authorbooleannullable

Written by the post's author (the creator's own comment, marked as such by the platform).

metricsobject

Counts at fetch time; null = hidden or not exposed, 0 = zero.

ShowHide 2 child fields
like_countintegernullable

Likes or upvotes; never negative.

reply_countintegernullable

Direct replies.

platform_specificobject

Fields only this platform has, under its ID (platform_specific.<platform>); each null when unknown.

ShowHide 8 child fields

These fields, in this page's Markdown

approximate_fieldsstring[]

JSON paths of values rounded by the platform or parsed from display text. A list path (external_links) means the list may be incomplete. [] when all exact.

unknown_fieldsstring[]

JSON paths of lists whose [] means unknown rather than none (a source that cannot see them); null already means unknown for every other field. [] when every list is known.

Item errors

Besides the request-level errors every endpoint can return, comment endpoints return:

CodeHTTPRetryMeaningWhat to do
not_found404NoThe item does not exist or was deleted. On GET /v1/requests/{id}/response: the response was not kept (details.reason says why).Check the link or ID. Do not retry.
private_or_unavailable403NoThe item exists but is not public: it is private, age- or region-restricted, or needs a login to view. It shares 403 with forbidden (which is about the key), so branch on the code.Only public items can be fetched. Do not retry.

Last updated