Skip to main content

Tag API

TagClient manages tags for workflows and executions.

Access

const tag = client.tags();

Methods

list(params?)

List all tags.

const { data, nextCursor } = await client.tags().list({ limit: 20 });

get(id)

Get a tag by ID.

const tag = await client.tags().get('tag-123');

create(data)

Create a new tag.

const tag = await client.tags().create({ name: 'production' });

update(id, data)

Update a tag.

const updated = await client.tags().update('tag-123', { name: 'prod' });

delete(id)

Delete a tag.

const deleted = await client.tags().delete('tag-123');

TagResource

Use getResource(), listResources(), or createResource() to get a bound TagResource instance.

const resource = await client.tags().getResource('tag-123');

Properties

PropertyTypeDescription
idstringTag ID
namestringTag name

Methods

MethodReturnsDescription
update(data)thisUpdate the tag — replaces snapshot with the API response
patch(data)thisConvenience update — merges partial fields into the current tag snapshot before updating
delete()TagDelete the tag