Skyvern: List job recipe runs

← Recipes operations · Get started

Operation skyvern.list_job_recipe_runs_v1_recipes_jobs_runs_get

Provider route: GET /v1/recipes/jobs/runs. 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["recipes"]["listJobRecipeRuns"]>[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.recipes.listJobRecipeRuns(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.recipes.list_job_recipe_runs(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. Default: 1 Minimum: 1
query.page_size	integer	Optional	Number of runs per page. Default: 25 Maximum: 100 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
$	Model	Root	Expand List job recipe runs — response body

Referenced models: List job recipe runs — response body

Schemas

List job recipe runs — response body

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
has_next	boolean	Required within parent
page	JSON	Required within parent
page (anyOf 1)	integer	Alternative
page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
page_size	JSON	Required within parent
page_size (anyOf 1)	integer	Alternative
page_size (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
runs	array	Required within parent
runs[]	Model	Each item	Expand List job recipe runs — response body — runs item

Referenced models: List job recipe runs — response body — runs item

List job recipe runs — response body — runs item

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
created_at	string	Required within parent	Format: date-time
failure_reason	JSON	Required within parent
failure_reason (anyOf 1)	string	Alternative
failure_reason (anyOf 2)	null	Alternative
job_url	JSON	Required within parent
job_url (anyOf 1)	string	Alternative
job_url (anyOf 2)	null	Alternative
next_step	JSON	Required within parent	What to do about an unsuccessful outcome; null for completed, canceled, and running runs.
next_step (anyOf 1)	string	Alternative
next_step (anyOf 2)	null	Alternative
outcome	JSON	Required within parent	Typed result of a finished run; null while it is still running. Apply failures name their cause (job_unavailable, login_required, application_refused, blocked_by_site, invalid_input, insufficient_credits, incomplete); a cause Skyvern cannot classify is failed, and so is every Extract failure except one Skyvern itself reports, such as running out of credits.
outcome (anyOf 1)	string	Alternative	Known values: completed, canceled, job_unavailable, login_required, application_refused, blocked_by_site, invalid_input, insufficient_credits, incomplete, failed
outcome (anyOf 2)	null	Alternative
recipe	string	Required within parent	Known values: apply, extract
status	string	Required within parent
workflow_permanent_id	string	Required within parent
workflow_run_id	string	Required within parent	Pattern: ^wr_

Policy, approvals and errors

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