Tags

Last updated 8 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

200

application/json

404

Tag category or workspace not found

application/json

get

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"
}

Delete tag category

delete

Remove a specific tag category.

Authorizations

Path parameters

workspaceIdstringRequired

categoryIdstringRequired

Responses

204

Deleted

404

Tag category or workspace not found

application/json

409

Tag category still being used

application/json

422

Invalid request

application/json

delete

DELETE /workspaces/{workspaceId}/tags/categories/{categoryId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

No content

List tags

get

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

Authorizations

Path parameters

workspaceIdstringRequired

Query parameters

limitinteger · min: 1 · max: 100Optional

Limits the number of results to return

Default: 10

pageTokenstring · max: 8000Optional

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

reversebooleanOptional

Order in which to retrieve the results

Default: false

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

Possible values:

includeDeletedbooleanOptional

Will also return deleted tags

sortBystring · enumOptional

Sort by field specified

Possible values:

Responses

200

application/json

Responseall of

404

Workspace not found

application/json

get

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
}

Get tag

get

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

Authorizations

Path parameters

workspaceIdstringRequired

tagIdstringRequired

Responses

200

application/json

404

Tag or workspace not found

application/json

get

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"
}

Delete tag

delete

Remove a specific tag.

Authorizations

Path parameters

workspaceIdstringRequired

tagIdstringRequired

Responses

204

Deleted

404

Tag or workspace not found

application/json

delete

DELETE /workspaces/{workspaceId}/tags/{tagId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

No content

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: 100Optional

Limits the number of results to return

Default: 10

pageTokenstring · max: 8000Optional

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

reversebooleanOptional

Order in which to retrieve the results

Default: false

Responses

200

application/json

Responseall of

404

Workspace, feed or item not found

application/json

get

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-05-29T08:49:37.973Z"
    }
  ],
  "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

200

application/json

404

Feed, item, tag, item tag or workspace not found

application/json

get

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-05-29T08:49:37.973Z"
}

Delete Item Tag

delete

Remove a specific tag associated with an item.

Authorizations

Path parameters

workspaceIdstringRequired

feedIdstringRequired

itemIdstringRequired

Feed Item UUID

tagIdstringRequired

Responses

204

Deleted

404

Item tag or workspace not found

application/json

delete

DELETE /workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}/tags/{tagId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

No content

List tags categories

get

Retrieve a list of tag categories

Authorizations

Path parameters

workspaceIdstringRequired

Query parameters

limitinteger · min: 1 · max: 100Optional

Limits the number of results to return

Default: 10

pageTokenstring · max: 8000Optional

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

reversebooleanOptional

Order in which to retrieve the results

Default: false

Responses

200

application/json

Responseall of

404

Workspace not found

application/json

get

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 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: 25RequiredPattern: ^([a-zA-Z0-9-_]+\s)*[a-zA-Z0-9-_]+$

descriptionstring · max: 1024OptionalPattern: ^(\S.*\S|\S)*$

emojistringRequired

Responses

201

created

409

Tag category already exists

application/json

422

Invalid request

application/json

post

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

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: 25OptionalPattern: ^([a-zA-Z0-9-_]+\s)*[a-zA-Z0-9-_]+$

descriptionstring · max: 1024OptionalPattern: ^(\S.*\S|\S)*$

emojistringOptional

Responses

200

updated

application/json

404

Tag category or workspace not found

application/json

409

Tag category already exists

application/json

422

Invalid request

application/json

patch

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"
}

Create new tag

post

Create a new tag within a specific category

Authorizations

Path parameters

workspaceIdstringRequired

Body

namestring · min: 1 · max: 25RequiredPattern: ^([a-zA-Z0-9-_]+\s)*[a-zA-Z0-9-_]+$

descriptionstring · max: 1024OptionalPattern: ^(\S.*\S|\S)*$

statusstring · enumRequiredPossible values:

categoryIdstringOptional

Responses

201

created

404

Workspace not found

application/json

409

Tag already exists

application/json

422

Invalid request

application/json

post

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

Update tag

patch

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

Authorizations

Path parameters

workspaceIdstringRequired

tagIdstringRequired

Body

namestring · min: 1 · max: 25OptionalPattern: ^([a-zA-Z0-9-_]+\s)*[a-zA-Z0-9-_]+$

descriptionstring · max: 1024OptionalPattern: ^(\S.*\S|\S)*$

statusstring · enumOptionalPossible values:

categoryIdstring | nullableOptional

Responses

200

updated

application/json

404

Tag or workspace not found

application/json

409

Tag already exists

application/json

422

Invalid request

application/json

patch

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"
}

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

201

Created

application/json

404

Workspace, feed, item or tag not found

application/json

409

Item tag already exists

application/json

422

Invalid item tag

application/json

post

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-05-29T08:49:37.973Z"
  }
]