Skip to main content

​
Endpoint

POST https://api.ugc.inc/comment

​
Overview

Retrieve comments for your organization. You can filter by specific comment IDs, account IDs, or account tag.

​
Request Body

​
commentIds
string[]
Get specific comments by their IDs.
​
accountIds
string[]
Filter comments by account IDs. Only returns comments made by these accounts.
​
tag
string
Filter comments by account tag. Returns comments from all accounts that have this tag.

​
Response

​
data
Comment[]
Array of comment objectsEach comment includes:
  • id: Unique comment identifier
  • accountId: Account ID used for the comment
  • postUrl: URL of the TikTok post
  • commentText: The comment text
  • status: Current status (pending, running, completed, failed)
  • commentUrl: URL to the posted comment (if completed)
  • error: Error message (if failed)
  • createdAt: When the comment was created
  • completedAt: When the comment completed (if applicable)
curl -X POST https://api.ugc.inc/comment \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{
  "code": 200,
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "accountId": "acc_123456",
      "postUrl": "https://www.tiktok.com/@creator/video/7234567890123456789",
      "commentText": "Great video! 🔥",
      "status": "completed",
      "commentUrl": "https://www.tiktok.com/@creator/video/7234567890123456789?comment_id=7000000000000000001",
      "error": null,
      "createdAt": "2024-01-15T10:30:00.000Z",
      "completedAt": "2024-01-15T10:31:00.000Z"
    },
    {
      "id": "660e8400-e29b-41d4-a716-446655440001",
      "accountId": "acc_789012",
      "postUrl": "https://www.tiktok.com/@another/video/7234567890123456790",
      "commentText": "Love this!",
      "status": "pending",
      "commentUrl": null,
      "error": null,
      "createdAt": "2024-01-15T11:00:00.000Z",
      "completedAt": null
    }
  ]
}