Dataset.add_tag¶
Attach an existing tag to this dataset.
Takes a tag id, not a name: the server route is
POST /api/tags/datasets/{dataset_id}/add/{tag_id}, which associates
an existing tag. This is symmetric with remove_tag.
Signature¶
add_tag(tag_id: str) -> dict[str, Any]
Parameters¶
| Name | Type | Required | Default |
|---|---|---|---|
tag_id |
str |
yes | - |
HTTP parameters¶
| Name | In | Type | Required | Default |
|---|---|---|---|---|
dataset_id |
path |
string |
yes | - |
tag_id |
path |
string |
yes | - |
Fields¶
| Field |
|---|
tag_id |
Return shape¶
HTTP 201 — Created
Schema: TagSchema
| Field | Type | Required |
|---|---|---|
color |
string |
yes |
dataset_count |
integer |
no |
id |
string |
yes |
name |
string |
yes |
notebook_count |
integer |
no |
project_count |
integer |
no |
Permission¶
Required permission: Team membership required
HTTP¶
POST /api/tags/datasets/{id}/add/{tag_id} (addTagToDataset)
Usage¶
ds.add_tag(tag.id)