Tags
Retrieve a list of tag categories
Limits the number of results to return
10
Pagination token that keeps of track of the current position in the list
Order in which to retrieve the results
false
GET /workspaces/{workspaceId}/tags/categories HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"results": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"emoji": "text",
"createdAt": "text",
"updatedAt": "text"
}
],
"nextPageToken": "text",
"total": 1
}
Create a new category to organize tags based on specific attributes or characteristics.
^([a-zA-Z0-9-_]+\s)*[a-zA-Z0-9-_]+$
^(\S.*\S|\S)*$
POST /workspaces/{workspaceId}/tags/categories HTTP/1.1
Host:
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 51
{
"name": "text",
"description": "text",
"emoji": "text"
}
No content
Retrieve information about a specific tag category, including its name, description.
GET /workspaces/{workspaceId}/tags/categories/{categoryId} HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"emoji": "text",
"createdAt": "text",
"updatedAt": "text"
}
Modify the details of a specific tag category, such as its name, description.
^([a-zA-Z0-9-_]+\s)*[a-zA-Z0-9-_]+$
^(\S.*\S|\S)*$
PATCH /workspaces/{workspaceId}/tags/categories/{categoryId} HTTP/1.1
Host:
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 51
{
"name": "text",
"description": "text",
"emoji": "text"
}
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"emoji": "text",
"createdAt": "text",
"updatedAt": "text"
}
Remove a specific tag category.
DELETE /workspaces/{workspaceId}/tags/categories/{categoryId} HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
No content
Retrieve a list of all tags associated with a specific category.
Limits the number of results to return
10
Pagination token that keeps of track of the current position in the list
Order in which to retrieve the results
false
Filter by tag name begins with
Filter by tag name exact match
Filter by tag category ID
Filter by tag status
Will also return deleted tags
Sort by field specified
GET /workspaces/{workspaceId}/tags HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"results": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"status": "draft",
"category": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"emoji": "text",
"createdAt": "text",
"updatedAt": "text"
},
"agentCount": 1,
"itemCount": 1,
"macroCount": 1,
"createdAt": "text",
"updatedAt": "text",
"deletedAt": "text",
"lastUsed": {
"addedToItemAt": "text",
"addedToItemId": "123e4567-e89b-12d3-a456-426614174000",
"removedFromItemAt": "text",
"removedFromItemId": "123e4567-e89b-12d3-a456-426614174000"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"nextPageToken": "text",
"total": 1
}
Create a new tag within a specific category
^([a-zA-Z0-9-_]+\s)*[a-zA-Z0-9-_]+$
^(\S.*\S|\S)*$
POST /workspaces/{workspaceId}/tags HTTP/1.1
Host:
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 73
{
"name": "text",
"description": "text",
"status": "draft",
"categoryId": "text"
}
No content
Retrieve information about a specific tag, including its name, category id.
GET /workspaces/{workspaceId}/tags/{tagId} HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"status": "draft",
"category": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"emoji": "text",
"createdAt": "text",
"updatedAt": "text"
},
"agentCount": 1,
"itemCount": 1,
"macroCount": 1,
"createdAt": "text",
"updatedAt": "text",
"deletedAt": "text",
"lastUsed": {
"addedToItemAt": "text",
"addedToItemId": "123e4567-e89b-12d3-a456-426614174000",
"removedFromItemAt": "text",
"removedFromItemId": "123e4567-e89b-12d3-a456-426614174000"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}
Modify the details of a specific tag, such as its name.
^([a-zA-Z0-9-_]+\s)*[a-zA-Z0-9-_]+$
^(\S.*\S|\S)*$
PATCH /workspaces/{workspaceId}/tags/{tagId} HTTP/1.1
Host:
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 73
{
"name": "text",
"description": "text",
"status": "draft",
"categoryId": "text"
}
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"status": "draft",
"category": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"emoji": "text",
"createdAt": "text",
"updatedAt": "text"
},
"agentCount": 1,
"itemCount": 1,
"macroCount": 1,
"createdAt": "text",
"updatedAt": "text",
"deletedAt": "text",
"lastUsed": {
"addedToItemAt": "text",
"addedToItemId": "123e4567-e89b-12d3-a456-426614174000",
"removedFromItemAt": "text",
"removedFromItemId": "123e4567-e89b-12d3-a456-426614174000"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}
Retrieve a list of tags associated with a specific feed item.
Represents an identifier for feed or feed contents. Supported formats ':' or '::', for example 'channel:747d7564-9ec1-461a-ad3a-2a3a55124917' or 'participant:contact:c453186d-c1e1-494d-9176-1673e1a542ee'
Feed Item UUID
Limits the number of results to return
10
Pagination token that keeps of track of the current position in the list
Order in which to retrieve the results
false
GET /workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}/tags HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"results": [
{
"itemId": "text",
"tag": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"status": "draft",
"category": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"emoji": "text",
"createdAt": "text",
"updatedAt": "text"
},
"agentCount": 1,
"itemCount": 1,
"macroCount": 1,
"createdAt": "text",
"updatedAt": "text",
"deletedAt": "text",
"lastUsed": {
"addedToItemAt": "text",
"addedToItemId": "123e4567-e89b-12d3-a456-426614174000",
"removedFromItemAt": "text",
"removedFromItemId": "123e4567-e89b-12d3-a456-426614174000"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"createdAt": "2025-07-10T01:54:50.323Z"
}
],
"nextPageToken": "text",
"total": 1
}
Associate a new tag with a specific feed item, categorizing and labeling it based on specific attributes.
Represents an identifier for feed or feed contents. Supported formats ':' or '::', for example 'channel:747d7564-9ec1-461a-ad3a-2a3a55124917' or 'participant:contact:c453186d-c1e1-494d-9176-1673e1a542ee'
Feed Item UUID
POST /workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}/tags HTTP/1.1
Host:
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 51
{
"tagIds": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
[
{
"itemId": "text",
"tag": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"status": "draft",
"category": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"emoji": "text",
"createdAt": "text",
"updatedAt": "text"
},
"agentCount": 1,
"itemCount": 1,
"macroCount": 1,
"createdAt": "text",
"updatedAt": "text",
"deletedAt": "text",
"lastUsed": {
"addedToItemAt": "text",
"addedToItemId": "123e4567-e89b-12d3-a456-426614174000",
"removedFromItemAt": "text",
"removedFromItemId": "123e4567-e89b-12d3-a456-426614174000"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"createdAt": "2025-07-10T01:54:50.323Z"
}
]
Retrieve information about a specific tag associated with an feed item.
Represents an identifier for feed or feed contents. Supported formats ':' or '::', for example 'channel:747d7564-9ec1-461a-ad3a-2a3a55124917' or 'participant:contact:c453186d-c1e1-494d-9176-1673e1a542ee'
Feed Item UUID
GET /workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}/tags/{tagId} HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"itemId": "text",
"tag": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"status": "draft",
"category": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"emoji": "text",
"createdAt": "text",
"updatedAt": "text"
},
"agentCount": 1,
"itemCount": 1,
"macroCount": 1,
"createdAt": "text",
"updatedAt": "text",
"deletedAt": "text",
"lastUsed": {
"addedToItemAt": "text",
"addedToItemId": "123e4567-e89b-12d3-a456-426614174000",
"removedFromItemAt": "text",
"removedFromItemId": "123e4567-e89b-12d3-a456-426614174000"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"createdAt": "2025-07-10T01:54:50.323Z"
}
Remove a specific tag associated with an item.
Represents an identifier for feed or feed contents. Supported formats ':' or '::', for example 'channel:747d7564-9ec1-461a-ad3a-2a3a55124917' or 'participant:contact:c453186d-c1e1-494d-9176-1673e1a542ee'
Feed Item UUID
DELETE /workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}/tags/{tagId} HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
No content
Last updated
Was this helpful?