api.socialfetch.dev

{
  "description": "Standard success response envelope.",
  "properties": {
    "data": {
      "description": "Endpoint-specific response payload.",
      "properties": {
        "comments": {
          "description": "Top-level comments for the resolved video.",
          "items": {
            "description": "A single top-level comment on a TikTok video.",
            "properties": {
              "author": {
                "description": "Comment author.",
                "properties": {
                  "avatarUrl": {
                    "description": "Profile image URL for the commenter when available.",
                    "nullable": true,
                    "type": "string"
                  },
                  "displayName": {
                    "description": "Display name shown on the commenter profile.",
                    "nullable": true,
                    "type": "string"
                  },
                  "handle": {
                    "description": "Public TikTok username without a leading @.",
                    "minLength": 1,
                    "type": "string"
                  },
                  "platformUserId": {
                    "description": "Numeric user id for the commenter when available.",
                    "type": "string"
                  },
                  "secUid": {
                    "description": "Opaque stable user identifier when available.",
                    "type": "string"
                  }
                },
                "required": [
                  "handle",
                  "displayName",
                  "avatarUrl"
                ],
                "type": "object"
              },
              "createdAt": {
                "description": "ISO-8601 timestamp when the comment was created.",
                "type": "string"
              },
              "id": {
                "description": "Stable identifier for the comment.",
                "minLength": 1,
                "type": "string"
              },
              "language": {
                "description": "Reported language code for the comment text.",
                "type": "string"
              },
              "likes": {
                "description": "Like count on the comment.",
                "minimum": 0,
                "type": "integer"
              },
              "replyCount": {
                "description": "Direct reply count for the comment thread.",
                "minimum": 0,
                "type": "integer"
              },
              "text": {
                "description": "Comment text.",
                "type": "string"
              }
            },
            "required": [
              "id",
              "text",
              "createdAt",
              "likes",
              "replyCount",
              "language",
              "author"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "lookupStatus": {
          "description": "Whether the video was resolved for this request.",
          "enum": [
            "found",
            "not_found"
          ],
          "type": "string"
        },
        "page": {
          "description": "Pagination information for this response.",
          "properties": {
            "hasMore": {
              "description": "Whether another page of comments is available.",
              "type": "boolean"
            },
            "nextCursor": {
              "description": "Cursor to pass in the next request when more pages exist.",
              "nullable": true,
              "type": "string"
            }
          },
          "required": [
            "nextCursor",
            "hasMore"
          ],
          "type": "object"
        },
        "totalComments": {
          "description": "Total comment count reported for the video when available; null when the video could not be resolved.",
          "minimum": 0,
          "nullable": true,
          "type": "integer"
        }
      },
      "required": [
        "lookupStatus",
        "comments",
        "page",
        "totalComments"
      ],
      "type": "object"
    },
    "meta": {
      "description": "Metadata describing the request and billing outcome.",
      "properties": {
        "cached": {
          "description": "True when served from shared response cache. Credits still apply (full endpoint price); Age header may be present.",
          "type": "boolean"
        },
        "creditsCharged": {
          "description": "Credits charged for this request.",
          "minimum": 0,
          "type": "integer"
        },
        "requestId": {
          "description": "Unique request identifier for tracing this API call.",
          "minLength": 1,
          "type": "string"
        },
        "version": {
          "description": "Public API version that served the response.",
          "enum": [
            "v1"
          ],
          "type": "string"
        }
      },
      "required": [
        "requestId",
        "creditsCharged",
        "version"
      ],
      "type": "object"
    }
  },
  "required": [
    "data",
    "meta"
  ],
  "type": "object"
}