Skyvern: Get all scripts

← Scripts operations · Get started

Operation skyvern.get_scripts_v1_scripts_get

Provider route: GET /v1/scripts. 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["scripts"]["getScripts"]>[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.scripts.getScripts(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.scripts.get_scripts(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.page	integer	Optional	Page number for pagination Default: 1 Minimum: 1
query.page_size	integer	Optional	Number of items per page Default: 10 Minimum: 1

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
$	array	Root
$[]	Model	Each item	Expand Get script by ID — response body

Referenced models: Get script by ID — response body

Schemas

Get script by ID — response body

Field	Type	Presence	Description and constraints
$	object	Root
created_at	string	Required within parent	Timestamp when the script was created Format: date-time
deleted_at	JSON	Optional	Timestamp when the script was soft deleted
deleted_at (anyOf 1)	string	Alternative	Format: date-time
deleted_at (anyOf 2)	null	Alternative
modified_at	string	Required within parent	Timestamp when the script was last modified Format: date-time
organization_id	string	Required within parent	ID of the organization that owns this script
run_id	JSON	Optional	ID of the workflow run or task run that generated this script
run_id (anyOf 1)	string	Alternative
run_id (anyOf 2)	null	Alternative
script_id	string	Required within parent	User-facing script identifier, consistent across versions
script_revision_id	string	Required within parent	Unique identifier for this specific script revision
version	JSON	Required within parent
version (anyOf 1)	integer	Alternative	Version number of the script
version (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

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