Tags

List tags categories

Retrieve a list of tag categories

get

/workspaces/{workspaceId}/tags/categories

Authorizations

useraccessKey

Path parameters

workspaceIdstringrequired

Query parameters

limitinteger · min: 1 · max: 100 · default: 10

Limits the number of results to return

pageTokenstring · max: 8000

Pagination token that keeps of track of the current position in the list

reverseboolean

Order in which to retrieve the results

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/workspaces/{workspaceId}/tags/categories' \
  --header 'Authorization: Bearer jwt'

200

404

200

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "emoji": "text",
      "createdAt": "text",
      "updatedAt": "text",
      "icon": "none"
    }
  ],
  "nextPageToken": "text",
  "total": 1
}

OK

Create new tag category

Create a new category to organize tags based on specific attributes or characteristics.

post

/workspaces/{workspaceId}/tags/categories

Authorizations

useraccessKey

Path parameters

workspaceIdstringrequired

Body

namestring · min: 3 · max: 25required

Pattern: ^([a-zA-Z0-9-_]+\s)*[a-zA-Z0-9-_]+$

descriptionstring · max: 1024

Pattern: ^(\S.*\S|\S)*$

emojistringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/tags/categories' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","emoji":"text"}'

201

409

422

201

No body

created

Get tag category

Retrieve information about a specific tag category, including its name, description.

get

/workspaces/{workspaceId}/tags/categories/{categoryId}

Authorizations

useraccessKey

Path parameters

workspaceIdstringrequired

categoryIdstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/workspaces/{workspaceId}/tags/categories/{categoryId}' \
  --header 'Authorization: Bearer jwt'

200

404

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "emoji": "text",
  "createdAt": "text",
  "updatedAt": "text",
  "icon": "none"
}

OK

Update tag category

Modify the details of a specific tag category, such as its name, description.

patch

/workspaces/{workspaceId}/tags/categories/{categoryId}

Authorizations

useraccessKey

Path parameters

workspaceIdstringrequired

categoryIdstringrequired

Body

namestring · min: 3 · max: 25

Pattern: ^([a-zA-Z0-9-_]+\s)*[a-zA-Z0-9-_]+$

descriptionstring · max: 1024

Pattern: ^(\S.*\S|\S)*$

emojistring

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/workspaces/{workspaceId}/tags/categories/{categoryId}' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json'

200

404

409

422

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "emoji": "text",
  "createdAt": "text",
  "updatedAt": "text",
  "icon": "none"
}

updated

Delete tag category

Remove a specific tag category.

delete

/workspaces/{workspaceId}/tags/categories/{categoryId}

Authorizations

useraccessKey

Path parameters

workspaceIdstringrequired

categoryIdstringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/workspaces/{workspaceId}/tags/categories/{categoryId}' \
  --header 'Authorization: Bearer jwt'

204

404

409

422

204

No body

Deleted

List tags

Retrieve a list of all tags associated with a specific category.

get

/workspaces/{workspaceId}/tags

Authorizations

useraccessKey

Path parameters

workspaceIdstringrequired

Query parameters

limitinteger · min: 1 · max: 100 · default: 10

Limits the number of results to return

pageTokenstring · max: 8000

Pagination token that keeps of track of the current position in the list

reverseboolean

Order in which to retrieve the results

namestring

Filter by tag name begins with

nameExactstring

Filter by tag name exact match

categoryIdstring · uuid

Filter by tag category ID

statusstring · enum

Filter by tag status

Options: draft, active, deleted

includeDeletedboolean

Will also return deleted tags

sortBystring · enum

Sort by field specified

Options: createdAt, name

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/workspaces/{workspaceId}/tags' \
  --header 'Authorization: Bearer jwt'

200

404

200

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "category": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "emoji": "text",
        "createdAt": "text",
        "updatedAt": "text",
        "icon": "none"
      },
      "agentCount": 1,
      "itemCount": 1,
      "macroCount": 1,
      "createdAt": "text",
      "updatedAt": "text",
      "deletedAt": "text",
      "status": "draft",
      "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
}

OK

Create new tag

Create a new tag within a specific category

post

/workspaces/{workspaceId}/tags

Authorizations

useraccessKey

Path parameters

workspaceIdstringrequired

Body

namestring · min: 1 · max: 25required

Pattern: ^([a-zA-Z0-9-_]+\s)*[a-zA-Z0-9-_]+$

descriptionstring · max: 1024

Pattern: ^(\S.*\S|\S)*$

categoryIdstring

statusstring · enumrequired

Options: draft, active

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/tags' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","status":"draft"}'

201

404

409

422

201

No body

created

Get tag

Retrieve information about a specific tag, including its name, category id.

get

/workspaces/{workspaceId}/tags/{tagId}

Authorizations

useraccessKey

Path parameters

workspaceIdstringrequired

tagIdstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/workspaces/{workspaceId}/tags/{tagId}' \
  --header 'Authorization: Bearer jwt'

200

404

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "category": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "emoji": "text",
    "createdAt": "text",
    "updatedAt": "text",
    "icon": "none"
  },
  "agentCount": 1,
  "itemCount": 1,
  "macroCount": 1,
  "createdAt": "text",
  "updatedAt": "text",
  "deletedAt": "text",
  "status": "draft",
  "lastUsed": {
    "addedToItemAt": "text",
    "addedToItemId": "123e4567-e89b-12d3-a456-426614174000",
    "removedFromItemAt": "text",
    "removedFromItemId": "123e4567-e89b-12d3-a456-426614174000"
  },
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

OK

Update tag

Modify the details of a specific tag, such as its name.

patch

/workspaces/{workspaceId}/tags/{tagId}

Authorizations

useraccessKey

Path parameters

workspaceIdstringrequired

tagIdstringrequired

Body

namestring · min: 1 · max: 25

Pattern: ^([a-zA-Z0-9-_]+\s)*[a-zA-Z0-9-_]+$

descriptionstring · max: 1024

Pattern: ^(\S.*\S|\S)*$

categoryIdstring | nullable

statusstring · enum

Options: draft, active

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/workspaces/{workspaceId}/tags/{tagId}' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"status":"draft"}'

200

404

409

422

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "category": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "emoji": "text",
    "createdAt": "text",
    "updatedAt": "text",
    "icon": "none"
  },
  "agentCount": 1,
  "itemCount": 1,
  "macroCount": 1,
  "createdAt": "text",
  "updatedAt": "text",
  "deletedAt": "text",
  "status": "draft",
  "lastUsed": {
    "addedToItemAt": "text",
    "addedToItemId": "123e4567-e89b-12d3-a456-426614174000",
    "removedFromItemAt": "text",
    "removedFromItemId": "123e4567-e89b-12d3-a456-426614174000"
  },
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

updated

Delete tag

Remove a specific tag.

delete

/workspaces/{workspaceId}/tags/{tagId}

Authorizations

useraccessKey

Path parameters

workspaceIdstringrequired

tagIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/workspaces/{workspaceId}/tags/{tagId}' \
  --header 'Authorization: Bearer jwt'

204

404

204

No body

Deleted

List Item Tags

Retrieve a list of tags associated with a specific feed item.

get

/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}/tags

Authorizations

useraccessKey

Path parameters

workspaceIdstringrequired

feedIdstringrequired

Represents an identifier for feed or feed contents. Supported formats '<indexType>:<feedId>' or '<indexType>:<idPrefix>:<feedId>', for example 'channel:747d7564-9ec1-461a-ad3a-2a3a55124917' or 'participant:contact:c453186d-c1e1-494d-9176-1673e1a542ee'

itemIdstringrequired

Feed Item UUID

Query parameters

limitinteger · min: 1 · max: 100 · default: 10

Limits the number of results to return

pageTokenstring · max: 8000

Pagination token that keeps of track of the current position in the list

reverseboolean

Order in which to retrieve the results

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}/tags' \
  --header 'Authorization: Bearer jwt'

200

404

200

{
  "results": [
    {
      "itemId": "text",
      "tag": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "category": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "description": "text",
          "emoji": "text",
          "createdAt": "text",
          "updatedAt": "text",
          "icon": "none"
        },
        "agentCount": 1,
        "itemCount": 1,
        "macroCount": 1,
        "createdAt": "text",
        "updatedAt": "text",
        "deletedAt": "text",
        "status": "draft",
        "lastUsed": {
          "addedToItemAt": "text",
          "addedToItemId": "123e4567-e89b-12d3-a456-426614174000",
          "removedFromItemAt": "text",
          "removedFromItemId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "createdAt": "2025-02-21T18:05:30.441Z"
    }
  ],
  "nextPageToken": "text",
  "total": 1
}

OK

Create Item Tag

Associate a new tag with a specific feed item, categorizing and labeling it based on specific attributes.

post

/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}/tags

Authorizations

useraccessKey

Path parameters

workspaceIdstringrequired

feedIdstringrequired

Represents an identifier for feed or feed contents. Supported formats '<indexType>:<feedId>' or '<indexType>:<idPrefix>:<feedId>', for example 'channel:747d7564-9ec1-461a-ad3a-2a3a55124917' or 'participant:contact:c453186d-c1e1-494d-9176-1673e1a542ee'

itemIdstringrequired

Feed Item UUID

Body

tagIdstring · uuid | nullableDeprecated

tagIdsstring · uuid[] | nullable

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}/tags' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"tagIds":[null]}'

201

404

409

422

201

[
  {
    "itemId": "text",
    "tag": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "category": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "emoji": "text",
        "createdAt": "text",
        "updatedAt": "text",
        "icon": "none"
      },
      "agentCount": 1,
      "itemCount": 1,
      "macroCount": 1,
      "createdAt": "text",
      "updatedAt": "text",
      "deletedAt": "text",
      "status": "draft",
      "lastUsed": {
        "addedToItemAt": "text",
        "addedToItemId": "123e4567-e89b-12d3-a456-426614174000",
        "removedFromItemAt": "text",
        "removedFromItemId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "createdAt": "2025-02-21T18:05:30.441Z"
  }
]

Created

Get Item Tag

Retrieve information about a specific tag associated with an feed item.

get

/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}/tags/{tagId}

Authorizations

useraccessKey

Path parameters

workspaceIdstringrequired

feedIdstringrequired

Represents an identifier for feed or feed contents. Supported formats '<indexType>:<feedId>' or '<indexType>:<idPrefix>:<feedId>', for example 'channel:747d7564-9ec1-461a-ad3a-2a3a55124917' or 'participant:contact:c453186d-c1e1-494d-9176-1673e1a542ee'

itemIdstringrequired

Feed Item UUID

tagIdstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}/tags/{tagId}' \
  --header 'Authorization: Bearer jwt'

200

404

200

{
  "itemId": "text",
  "tag": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "category": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "emoji": "text",
      "createdAt": "text",
      "updatedAt": "text",
      "icon": "none"
    },
    "agentCount": 1,
    "itemCount": 1,
    "macroCount": 1,
    "createdAt": "text",
    "updatedAt": "text",
    "deletedAt": "text",
    "status": "draft",
    "lastUsed": {
      "addedToItemAt": "text",
      "addedToItemId": "123e4567-e89b-12d3-a456-426614174000",
      "removedFromItemAt": "text",
      "removedFromItemId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "createdAt": "2025-02-21T18:05:30.441Z"
}

OK

Delete Item Tag

Remove a specific tag associated with an item.

delete

/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}/tags/{tagId}

Authorizations

useraccessKey

Path parameters

workspaceIdstringrequired

feedIdstringrequired

Represents an identifier for feed or feed contents. Supported formats '<indexType>:<feedId>' or '<indexType>:<idPrefix>:<feedId>', for example 'channel:747d7564-9ec1-461a-ad3a-2a3a55124917' or 'participant:contact:c453186d-c1e1-494d-9176-1673e1a542ee'

itemIdstringrequired

Feed Item UUID

tagIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}/tags/{tagId}' \
  --header 'Authorization: Bearer jwt'

204

404

204

No body

Deleted