Skip to main content

​
Description

Adds a CollectionService tag to an instance. If the tag already exists on the instance, this operation has no additional effect.

​
Endpoint

add_tag

​
Parameters

​
path
string
required
The path to the instance (e.g., “Workspace.Part” or “ReplicatedStorage.Enemy”)
​
tag
string
required
The tag name to add

​
Response

​
ok
boolean
Returns true if the tag was added successfully
​
error
string
Error message if the instance path could not be resolved

​
Examples

​
Add a single tag

{
  "path": "Workspace.Enemy",
  "tag": "Hostile"
}
Response: 
{
  "ok": true
}

​
Add a tag for collectibles

{
  "path": "Workspace.Coin",
  "tag": "Collectible"
}
Response: 
{
  "ok": true
}

​
Error handling

{
  "path": "Workspace.NonExistent",
  "tag": "SomeTag"
}
Response: 
{
  "error": "Instance not found: Workspace.NonExistent"
}

Build docs developers (and LLMs) love

Get started for freeTalk to us