Create a thread

This endpoint enables you to create a thread within a specific room. A thread is essentially a collection of comments that can be associated with a specific point or area on the screen. It serves as a way to pin comments to particular locations, facilitating more precise and context-specific discussions.

How to use

You can use the following cURL to obtain a response on the endpoint:

curl --location --request POST https://api.superviz.com/threads \
  --header 'Content-Type: application/json' \
  --header "client_id: ${YOUR CLIENT_ID}" \
  --header "secret: ${YOUR SECRET}" \
  --data '{
    "participantId": "3337829",
    "position": "{ x: 100, y: 100, type: \"text\" }",
    "roomId": "yshanzy"
  }'

Headers

When using this endpoint, you need to provide the Client ID and Secret Key. The following headers are required:

Name	Description
client_id	Required. You need to use the Client ID to authenticate in this repository. You can retrieve your Client ID under the Dashboard > Developer > Keys.
secret	Required. You need to use the Secret Key to authenticate in this repository. You can create a new API Secret under our Dashboard > Developer > Keys.

Request Body

Name	Type	Description
participantId	string	The ID of the participant.
position	object	The position of the annotation.
roomId	string	The ID of the room.

Response

Status code 201 will indicate that the annotation was created successfully.

Name	Type	Description
uuid	string	The UUID of the annotation.
participantId	string	The ID of the participant.
position	object	The position of the annotation.
resolved	boolean	The status of the annotation.
createdAt	string	The date and time of the annotation.

Example:

{
  "uuid": "08fb673d-3b82-4847-9367-4bae347b352f",
  "participantId": "3337829",
  "position": "{ x: 100, y: 100, type: \"text\" }",
  "resolved": false,
  "createdAt": "2024-09-12T21:53:54.838Z"
}