Tags

Last updated 6 months ago

Was this helpful?

Get tag category

get

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

Authorizations

Path parameters

workspaceIdstringrequired

categoryIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

404

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

Delete tag category

delete

Remove a specific tag category.

Authorizations

Path parameters

workspaceIdstringrequired

categoryIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

204

404

409

422

No body

Deleted

List tags

get

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

Authorizations

Path parameters

workspaceIdstringrequired

Query parameters

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

Limits the number of results to return

pageTokenstring · max: 8000optional

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

reverseboolean · default: falseoptional

Order in which to retrieve the results

namestringoptional

Filter by tag name begins with

nameExactstringoptional

Filter by tag name exact match

categoryIdstring · uuidoptional

Filter by tag category ID

statusstring · enumoptional

Filter by tag status

Options: draft, active, deleted

includeDeletedbooleanoptional

Will also return deleted tags

sortBystring · enumoptional

Sort by field specified

Options: createdAt, name

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

404

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "status": "draft",
      "category": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "icon": "none",
        "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
}

Get tag

get

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

Authorizations

Path parameters

workspaceIdstringrequired

tagIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "status": "draft",
  "category": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "icon": "none",
    "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"
}

Delete tag

delete

Remove a specific tag.

Authorizations

Path parameters

workspaceIdstringrequired

tagIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

204

404

No body

Deleted

List Item Tags

get

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

Authorizations

Path parameters

workspaceIdstringrequired

feedIdstringrequired

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'

itemIdstringrequired

Feed Item UUID

Query parameters

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

Limits the number of results to return

pageTokenstring · max: 8000optional

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

reverseboolean · default: falseoptional

Order in which to retrieve the results

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

404

{
  "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",
          "icon": "none",
          "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-03-28T18:35:02.271Z"
    }
  ],
  "nextPageToken": "text",
  "total": 1
}

Get Item Tag

get

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

Authorizations

Path parameters

workspaceIdstringrequired

feedIdstringrequired

itemIdstringrequired

Feed Item UUID

tagIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

404

{
  "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",
      "icon": "none",
      "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-03-28T18:35:02.271Z"
}

Delete Item Tag

delete

Remove a specific tag associated with an item.

Authorizations

Path parameters

workspaceIdstringrequired

feedIdstringrequired

itemIdstringrequired

Feed Item UUID

tagIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

204

404

No body

Deleted

List tags categories

get

Retrieve a list of tag categories

Authorizations

Path parameters

workspaceIdstringrequired

Query parameters

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

Limits the number of results to return

pageTokenstring · max: 8000optional

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

reverseboolean · default: falseoptional

Order in which to retrieve the results

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

404

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

Create new tag category

post

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

Authorizations

Path parameters

workspaceIdstringrequired

Body

namestring · min: 3 · max: 25required

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

descriptionstring · max: 1024optional

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

emojistringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

201

409

422

No body

created

Update tag category

patch

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

Authorizations

Path parameters

workspaceIdstringrequired

categoryIdstringrequired

Body

namestring · min: 3 · max: 25optional

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

descriptionstring · max: 1024optional

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

emojistringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

404

409

422

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

updated

Create new tag

post

Create a new tag within a specific category

Authorizations

Path parameters

workspaceIdstringrequired

Body

namestring · min: 1 · max: 25required

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

descriptionstring · max: 1024optional

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

statusstring · enumrequired

Options: draft, active

categoryIdstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

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

201

404

409

422

No body

created

Update tag

patch

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

Authorizations

Path parameters

workspaceIdstringrequired

tagIdstringrequired

Body

namestring · min: 1 · max: 25optional

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

descriptionstring · max: 1024optional

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

statusstring · enumoptional

Options: draft, active

categoryIdstring | nullableoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

404

409

422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "status": "draft",
  "category": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "icon": "none",
    "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"
}

updated

Create Item Tag

post

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

Authorizations

Path parameters

workspaceIdstringrequired

feedIdstringrequired

itemIdstringrequired

Feed Item UUID

Body

tagIdstring · uuid | nullableoptionalDeprecated

tagIdsstring · uuid[] | nullableoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}/tags' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "tagId": "123e4567-e89b-12d3-a456-426614174000",
    "tagIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }'

201

404

409

422

[
  {
    "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",
        "icon": "none",
        "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-03-28T18:35:02.271Z"
  }
]

Created