Beta

Create Comment (File)

POSThttps://api.youvico.com/api/files/:id/comments
Rate Limit
Tier 4

Creates a comment or reply on a file.

Example

curl -X POST 'https://api.youvico.com/api/files/FX1234567890ABCD/comments' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "content": "Updated and re-exported.", "anchor": 12000, "duration": 3000, "parent": { "id": "2fb4e60b-0d9a-46f3-a4dc-cb9fe8ad9be6" } }'
{
  "data": {
    "id": "84202e58-bf8c-471d-af07-0ab0f5b0f82b"
  }
}
Request
curl -X POST 'https://api.youvico.com/api/files/FX1234567890ABCD/comments' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"content": "Updated and re-exported.",
"anchor": 12000,
"duration": 3000,
"parent": {
"id": "2fb4e60b-0d9a-46f3-a4dc-cb9fe8ad9be6"
}
}'
Response201 Created
{
  "data": {
    "id": "84202e58-bf8c-471d-af07-0ab0f5b0f82b"
  }
}

Request

Path

idstringrequired
File ID

Body

contentstring

Maximum 5000 characters

Comment text

Example: Updated and re-exported.

anchornumber

Integer, 0-2147483647

Video timestamp in milliseconds, or 1-based document page number

Example: 12000

durationnumber

Integer, 0-2147483647

Duration in the same unit as anchor

Example: 3000

parentobject
Parent comment. Omit to create a top-level comment
parent.idstringrequired

UUID

Top-level comment ID

Example: 2fb4e60b-0d9a-46f3-a4dc-cb9fe8ad9be6

attachmentsarray

1-10 items, unique IDs

Comment attachments
attachments[].idstringrequired
Completed comment attachment ID

Note

Send at least one of content, anchor, or attachments with a value. Send duration only together with anchor.

Response

Returns 201 Created.

dataobject
Created comment
data.idstring
ID of the created comment

Example: 84202e58-bf8c-471d-af07-0ab0f5b0f82b