Skip to content

Skyvern: List run tag suggestions

Skyvern tags.getRunTagSuggestions: arguments, response, policy and SDK examples.

← Tags operations · Get started

Operation skyvern.get_run_tag_suggestions_v1_run_tag_suggestions_get

Provider route: GET /v1/run-tag-suggestions. Alter supplies the connection’s credentials and routing.

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"]["getRunTagSuggestions"]>[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.getRunTagSuggestions(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.get_run_tag_suggestions(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed

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

FieldTypePresenceDescription and constraints
$ModelRootExpand List run tag suggestions — response body

Referenced models: List run tag suggestions — response body

List run tag suggestions — response body
FieldTypePresenceDescription and constraints
$objectRootResponse 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.
keysarrayOptionalDistinct grouped tag keys seen on runs.
keys[]stringEach item
labelsarrayOptionalDistinct standalone (keyless) labels seen on runs.
labels[]stringEach item
values_by_keyobjectOptionalValues seen for each grouped key.
Additional keys: see wildcard field
values_by_key.*arrayAdditional keys
values_by_key.*[]stringEach item

SDK function policy ID: skyvern.get_run_tag_suggestions_v1_run_tag_suggestions_get. Catalog operation: get_run_tag_suggestions_v1_run_tag_suggestions_get. 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

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.