Tags

List tags categories

Retrieve a list of tag categories

GET/workspaces/{workspaceId}/tags/categories

Authorization

useraccessKey

Path parameters

workspaceId*string

Query parameters

Response

200404

OK

Body

application/json

results*array of TagCategory (object)

nextPageTokenstring

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.

totalinteger

The total number of results across all pages.

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/tags/categories', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

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

Create new tag category

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

POST/workspaces/{workspaceId}/tags/categories

Authorization

useraccessKey

Path parameters

workspaceId*string

Body

application/json

name*TagCategory_properties-name (string)

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

descriptiondescription (string)

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

emoji*emoji (string)

Response

201409422

created

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/tags/categories', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "emoji": "text"
    }),
});
const data = await response.json();

Response

409422

{
  "code": "text",
  "message": "text"
}

Get tag category

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

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

Authorization

useraccessKey

Path parameters

workspaceId*string

categoryId*string

Response

200404

OK

Body

application/json

id*string (uuid)

name*string

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

description*string

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

emoji*string

createdAt*string

updatedAt*string

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/tags/categories/{categoryId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

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

Update tag category

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

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

Authorization

useraccessKey

Path parameters

workspaceId*string

categoryId*string

Body

application/json

nameTagCategory_properties-name (string)

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

descriptiondescription (string)

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

emojiemoji (string)

Response

200404409422

updated

Body

application/json

id*string (uuid)

name*string

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

description*string

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

emoji*string

createdAt*string

updatedAt*string

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/tags/categories/{categoryId}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200404409422

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

Delete tag category

Remove a specific tag category.

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

Authorization

useraccessKey

Path parameters

workspaceId*string

categoryId*string

Response

204404409422

Deleted

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/tags/categories/{categoryId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

404409422

{
  "code": "text",
  "message": "text"
}

List tags

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

GET/workspaces/{workspaceId}/tags

Authorization

useraccessKey

Path parameters

workspaceId*string

Query parameters

Response

200404

OK

Body

application/json

results*array of Tag (object)

nextPageTokenstring

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.

totalinteger

The total number of results across all pages.

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/tags', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "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"
      },
      "createdAt": "text",
      "updatedAt": "text",
      "deletedAt": "text",
      "lastUsed": {
        "addedToItemAt": "text",
        "addedToItemId": "123e4567-e89b-12d3-a456-426614174000",
        "removedFromItemAt": "text",
        "removedFromItemId": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  ],
  "nextPageToken": "text"
}

Create new tag

Create a new tag within a specific category

POST/workspaces/{workspaceId}/tags

Authorization

useraccessKey

Path parameters

workspaceId*string

Body

application/json

name*Tag_properties-name (string)

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

descriptiondescription (string)

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

status*enum

draftactive

categoryIdstring

Response

201404409422

created

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/tags', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "status": "draft"
    }),
});
const data = await response.json();

Response

404409422

{
  "code": "text",
  "message": "text"
}

Get tag

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

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

Authorization

useraccessKey

Path parameters

workspaceId*string

tagId*string

Response

200404

OK

Body

application/json

id*string (uuid)

name*string

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

description*string

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

status*enum

draftactivedeleted

categoryTagCategory (object)

agentCountinteger

itemCountinteger

macroCountinteger

createdAt*string

updatedAt*string

deletedAtstring

lastUsedobject

Other propertiesany

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/tags/{tagId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "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"
  },
  "createdAt": "text",
  "updatedAt": "text",
  "deletedAt": "text",
  "lastUsed": {
    "addedToItemAt": "text",
    "addedToItemId": "123e4567-e89b-12d3-a456-426614174000",
    "removedFromItemAt": "text",
    "removedFromItemId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Update tag

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

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

Authorization

useraccessKey

Path parameters

workspaceId*string

tagId*string

Body

application/json

nameTag_properties-name (string)

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

descriptiondescription (string)

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

statusenum

draftactive

categoryIdnullable string

Response

200404409422

updated

Body

application/json

id*string (uuid)

name*string

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

description*string

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

status*enum

draftactivedeleted

categoryTagCategory (object)

agentCountinteger

itemCountinteger

macroCountinteger

createdAt*string

updatedAt*string

deletedAtstring

lastUsedobject

Other propertiesany

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/tags/{tagId}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200404409422

{
  "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"
  },
  "createdAt": "text",
  "updatedAt": "text",
  "deletedAt": "text",
  "lastUsed": {
    "addedToItemAt": "text",
    "addedToItemId": "123e4567-e89b-12d3-a456-426614174000",
    "removedFromItemAt": "text",
    "removedFromItemId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Delete tag

Remove a specific tag.

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

Authorization

useraccessKey

Path parameters

workspaceId*string

tagId*string

Response

204404

Deleted

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/tags/{tagId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

404

{
  "code": "text",
  "message": "text"
}

List Item Tags

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

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

Authorization

useraccessKey

Path parameters

workspaceId*string

feedId*string

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'

itemId*string

Feed Item UUID

Query parameters

Response

200404

OK

Body

application/json

results*array of ItemTag (object)

nextPageTokenstring

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.

totalinteger

The total number of results across all pages.

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}/tags', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "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"
        },
        "createdAt": "text",
        "updatedAt": "text",
        "deletedAt": "text",
        "lastUsed": {
          "addedToItemAt": "text",
          "addedToItemId": "123e4567-e89b-12d3-a456-426614174000",
          "removedFromItemAt": "text",
          "removedFromItemId": "123e4567-e89b-12d3-a456-426614174000"
        }
      },
      "createdAt": "2024-11-21T10:20:08.149Z"
    }
  ],
  "nextPageToken": "text"
}

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

Authorization

useraccessKey

Path parameters

workspaceId*string

feedId*string

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'

itemId*string

Feed Item UUID

Body

application/json

tagIdsnullable array of string (uuid)

Response

201404409422

Created

Body

application/json

itemId*string

tag*Tag (object)

createdAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}/tags', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201404409422

[
  {
    "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"
      },
      "createdAt": "text",
      "updatedAt": "text",
      "deletedAt": "text",
      "lastUsed": {
        "addedToItemAt": "text",
        "addedToItemId": "123e4567-e89b-12d3-a456-426614174000",
        "removedFromItemAt": "text",
        "removedFromItemId": "123e4567-e89b-12d3-a456-426614174000"
      }
    },
    "createdAt": "2024-11-21T10:20:08.149Z"
  }
]

Get Item Tag

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

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

Authorization

useraccessKey

Path parameters

workspaceId*string

feedId*string

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'

itemId*string

Feed Item UUID

tagId*string

Response

200404

OK

Body

application/json

itemId*string

tag*Tag (object)

createdAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}/tags/{tagId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "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"
    },
    "createdAt": "text",
    "updatedAt": "text",
    "deletedAt": "text",
    "lastUsed": {
      "addedToItemAt": "text",
      "addedToItemId": "123e4567-e89b-12d3-a456-426614174000",
      "removedFromItemAt": "text",
      "removedFromItemId": "123e4567-e89b-12d3-a456-426614174000"
    }
  },
  "createdAt": "2024-11-21T10:20:08.149Z"
}

Delete Item Tag

Remove a specific tag associated with an item.

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

Authorization

useraccessKey

Path parameters

workspaceId*string

feedId*string

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'

itemId*string

Feed Item UUID

tagId*string

Response

204404

Deleted

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}/tags/{tagId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

404

{
  "code": "text",
  "message": "text"
}