Skyvern: Tags schemas

← Tags operations · All schemas

Apply run tags — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Body for ``POST /v1/workflows/{wpid}/tags``. Either field may be empty (both empty is a no-op). On a same-identity collision, set wins over delete.
colors	JSON	Optional	Optional map of grouped tag key to palette color name for the value being set. Keys absent from this map keep their existing color or receive a random palette color.
colors (anyOf 1)	object	Alternative	Additional keys: see wildcard field
colors (anyOf 1).*	string	Additional keys
colors (anyOf 2)	null	Alternative
tags	array	Optional	Tags to set (overwrite). List of {key?, value} objects.
tags[]	Model	Each item	Expand Apply run tags — request body — body tags item
tags_to_delete	array	Optional	Tags to soft-delete. List of {key?, value?} targets.
tags_to_delete[]	Model	Each item	Expand Apply run tags — request body — body tags to delete item

Referenced models: Apply run tags — request body — body tags to delete item, Apply run tags — request body — body tags item

Apply run tags — request body — body tags item

Field	Type	Presence	Description and constraints
$	object	Root	One tag to set. ``value`` is the required label; ``key`` is the optional group — null for a standalone label, set for a grouped label (e.g. env:prod).
key	JSON	Optional	Optional group (key). Omit for a standalone label.
key (anyOf 1)	string	Alternative
key (anyOf 2)	null	Alternative
value	string	Required within parent	Label (value). Always required.

Apply run tags — request body — body tags to delete item

Field	Type	Presence	Description and constraints
$	object	Root	One tag to soft-delete: a grouped tag by its ``key``, or a standalone label by its ``value`` (omit the key).
key	JSON	Optional	Group (key) to delete. Use for grouped tags.
key (anyOf 1)	string	Alternative
key (anyOf 2)	null	Alternative
value	JSON	Optional	Label (value) to delete. Use for standalone labels.
value (anyOf 1)	string	Alternative
value (anyOf 2)	null	Alternative

Batch get agent tags (POST) — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Body for ``POST /v1/workflow-tags`` (used when the wpid list would exceed the URL length cap).
workflow_permanent_ids	array	Optional	Workflow permanent IDs to fetch tags for.
workflow_permanent_ids[]	string	Each item

Batch get agent tags — response body

Field	Type	Presence	Description and constraints
$	object	Root	Response for the batch endpoint. Workflows with no tags are present with an empty list so the frontend can distinguish "fetched, none set" from "not fetched" without a second call. Workflows outside the caller's org are silently absent (no leakage).
workflow_tags	object	Required within parent	Additional keys: see wildcard field
workflow_tags.*	array	Additional keys
workflow_tags.*[]	Model	Each item	Expand Batch get run tags — response body — run tags value item

Referenced models: Batch get run tags — response body — run tags value item

Batch get run tags (POST) — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Body for ``POST /v1/run-tags`` (used when the run-id list would exceed the URL length cap).
workflow_run_ids	array	Optional	Workflow run IDs to fetch tags for.
workflow_run_ids[]	string	Each item

Batch get run tags — response body

Field	Type	Presence	Description and constraints
$	object	Root	Response for the run-tags batch endpoint. Runs with no tags are present with an empty list so the frontend can distinguish "fetched, none set" from "not fetched" without a second call. Runs outside the caller's org are silently absent (no leakage).
run_tags	object	Required within parent	Additional keys: see wildcard field
run_tags.*	array	Additional keys
run_tags.*[]	Model	Each item	Expand Batch get run tags — response body — run tags value item

Referenced models: Batch get run tags — response body — run tags value item

Batch get run tags — response body — run tags value item

Field	Type	Presence	Description and constraints
$	object	Root	A single tag (key + label) without per-tag attribution. ``key`` is null for a standalone label.
key	JSON	Optional
key (anyOf 1)	string	Alternative
key (anyOf 2)	null	Alternative
value	string	Required within parent

Create tag value — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Body for ``POST /v1/tag-values``: register a grouped label before any workflow uses it. The label shows a zero workflow count until applied.
color	JSON	Optional	Palette color name for the label; a random palette color when omitted.
color (anyOf 1)	string	Alternative
color (anyOf 2)	null	Alternative
key	string	Required within parent	Tag key (group) for the new label.
value	string	Required within parent	Tag value (label) to register under the key.

Create tag value — response body

Field	Type	Presence	Description and constraints
$	object	Root	Tag-value color registry entry: the palette color assigned to a grouped (key, value) pair.
color	string	Required within parent
key	string	Required within parent
value	string	Required within parent
workflow_count	JSON	Optional
workflow_count (anyOf 1)	integer	Alternative	Number of non-deleted workflows currently carrying this (key, value) label. Default: 0
workflow_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Delete tag key — response body

Field	Type	Presence	Description and constraints
$	object	Root	Response for ``DELETE /v1/tag-keys/{key}``.
key	string	Required within parent
removed_count	JSON	Optional
removed_count (anyOf 1)	integer	Alternative	Default: 0
removed_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
removed_from_run_count	JSON	Optional
removed_from_run_count (anyOf 1)	integer	Alternative	Default: 0
removed_from_run_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
removed_from_workflow_count	JSON	Required within parent
removed_from_workflow_count (anyOf 1)	integer	Alternative
removed_from_workflow_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Delete tag value — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Body for ``DELETE /v1/tag-values/{key}``. The value rides in the body, not the path, so values containing ``/`` stay addressable.
value	string	Required within parent	Tag value (label) under the key to soft-delete.

Delete tag value — response body

Field	Type	Presence	Description and constraints
$	object	Root	Response for ``DELETE /v1/tag-values/{key}``.
key	string	Required within parent
removed_count	JSON	Optional
removed_count (anyOf 1)	integer	Alternative	Default: 0
removed_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
removed_from_run_count	JSON	Optional
removed_from_run_count (anyOf 1)	integer	Alternative	Default: 0
removed_from_run_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
removed_from_workflow_count	JSON	Required within parent
removed_from_workflow_count (anyOf 1)	integer	Alternative
removed_from_workflow_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
value	string	Required within parent

Get agent tag history — response body

Field	Type	Presence	Description and constraints
$	object	Root
events	array	Required within parent
events[]	Model	Each item	Expand Get run tag history — response body — events item
workflow_permanent_id	string	Required within parent

Referenced models: Get run tag history — response body — events item

Get agent tags — response body

Field	Type	Presence	Description and constraints
$	object	Root	Current tags for a workflow. A list (not a key-map) so standalone labels, which have no key, are representable.
tags	array	Required within parent
tags[]	Model	Each item	Expand Get run tags — response body — tags item
workflow_permanent_id	string	Required within parent

Referenced models: Get run tags — response body — tags item

Get run tag history — response body

Field	Type	Presence	Description and constraints
$	object	Root
events	array	Required within parent
events[]	Model	Each item	Expand Get run tag history — response body — events item
workflow_run_id	string	Required within parent

Referenced models: Get run tag history — response body — events item

Get run tag history — response body — events item

Field	Type	Presence	Description and constraints
$	object	Root	One row from ``GET /v1/workflows/{wpid}/tags/history``.
event_type	string	Required within parent
key	JSON	Required within parent
key (anyOf 1)	string	Alternative
key (anyOf 2)	null	Alternative
set_at	string	Required within parent	Format: date-time
set_by	string	Required within parent
source	string	Required within parent
superseded_at	JSON	Optional
superseded_at (anyOf 1)	string	Alternative	Format: date-time
superseded_at (anyOf 2)	null	Alternative
tag_event_id	string	Required within parent
value	JSON	Required within parent
value (anyOf 1)	string	Alternative
value (anyOf 2)	null	Alternative

Get run tags — response body

Field	Type	Presence	Description and constraints
$	object	Root	Current tags for a workflow run.
tags	array	Required within parent
tags[]	Model	Each item	Expand Get run tags — response body — tags item
workflow_run_id	string	Required within parent

Referenced models: Get run tags — response body — tags item

Get run tags — response body — tags item

Field	Type	Presence	Description and constraints
$	object	Root	Current state of one tag (``GET /v1/workflows/{wpid}/tags`` row). ``key`` is null for a standalone label.
key	JSON	Optional
key (anyOf 1)	string	Alternative
key (anyOf 2)	null	Alternative
set_at	string	Required within parent	Format: date-time
set_by	string	Required within parent
source	string	Required within parent
value	string	Required within parent

List run tag suggestions — response body

Field	Type	Presence	Description and constraints
$	object	Root	Response for ``GET /v1/run-tag-suggestions``: distinct (key, value) pairs ever set on a run for the org, sourced from the event log rather than the tag-key/tag-value registry so reserved ``skyvern.*`` system keys (never registered) reach the pickers too.
keys	array	Optional	Distinct grouped tag keys seen on runs.
keys[]	string	Each item
labels	array	Optional	Distinct standalone (keyless) labels seen on runs.
labels[]	string	Each item
values_by_key	object	Optional	Values seen for each grouped key. Additional keys: see wildcard field
values_by_key.*	array	Additional keys
values_by_key.*[]	string	Each item

Rename tag value — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Body for ``PATCH /v1/tag-values/{key}/rename``. Both the current and the new value ride in the body so values containing ``/`` stay addressable.
new_value	string	Required within parent	New tag value (label) to rename it to.
value	string	Required within parent	Current tag value (label) under the key to rename.

Rename tag value — response body

Field	Type	Presence	Description and constraints
$	object	Root	Response for ``PATCH /v1/tag-values/{key}/rename``: the renamed label with its carried-over color and the number of workflows re-tagged.
color	string	Required within parent
key	string	Required within parent
renamed_workflow_count	JSON	Required within parent
renamed_workflow_count (anyOf 1)	integer	Alternative
renamed_workflow_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
value	string	Required within parent

Update tag key — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Body for ``PATCH /v1/tag-keys/{key}``.
description	JSON	Optional	Free-form description (max 500 chars). Pass null to clear.
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative

Update tag key — response body

Field	Type	Presence	Description and constraints
$	object	Root	Tag-key registry entry.
description	JSON	Optional
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
key	string	Required within parent
workflow_count	JSON	Optional
workflow_count (anyOf 1)	integer	Alternative	Default: 0
workflow_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update tag value color — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Body for ``PATCH /v1/tag-values/{key}``. The value rides in the body, not the path, so values containing ``/`` stay addressable.
color	string	Required within parent	Palette color name to assign to this (key, value).
value	string	Required within parent	Tag value (label) under the key to recolor.