Skyvern: Apply run tags

← Tags operations · Get started

Operation skyvern.apply_run_tags_v1_runs_workflow_run_id_tags_post

Provider route: POST /v1/runs/{workflow_run_id}/tags. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/skyvern with npm, or alter-sdk-skyvern with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { SkyvernIntegration } from "@alter-ai/skyvern";

async function execute(input: Parameters<SkyvernIntegration["tags"]["applyRunTags"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new SkyvernIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.tags.applyRunTags(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_skyvern import SkyvernIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = SkyvernIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.tags.apply_run_tags(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.workflow_run_id	string	Required within parent	Workflow run ID
body	Model	Required within parent	Expand Apply run tags — request body — body

Referenced models: Apply run tags — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Get run tags — response body

Referenced models: Get run tags — response body

Schemas

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

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

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

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

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.

Policy, approvals and errors

SDK function policy ID: skyvern.apply_run_tags_v1_runs_workflow_run_id_tags_post. Catalog operation: apply_run_tags_v1_runs__workflow_run_id__tags_post. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source