Skip to content

Skyvern: Recipes schemas

3 Skyvern schemas with complete fields and constraints.

← Recipes operations · All schemas

Apply to a job — response body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
workflow_run_idstringRequired within parentPattern: ^wr_

List job recipe runs — response body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
has_nextbooleanRequired within parent
pageJSONRequired within parent
page (anyOf 1)integerAlternative
page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
page_sizeJSONRequired within parent
page_size (anyOf 1)integerAlternative
page_size (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
runsarrayRequired within parent
runs[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
created_atstringRequired within parentFormat: date-time
failure_reasonJSONRequired within parent
failure_reason (anyOf 1)stringAlternative
failure_reason (anyOf 2)nullAlternative
job_urlJSONRequired within parent
job_url (anyOf 1)stringAlternative
job_url (anyOf 2)nullAlternative
next_stepJSONRequired within parentWhat to do about an unsuccessful outcome; null for completed, canceled, and running runs.
next_step (anyOf 1)stringAlternative
next_step (anyOf 2)nullAlternative
outcomeJSONRequired within parentTyped 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)stringAlternativeKnown values: completed, canceled, job_unavailable, login_required, application_refused, blocked_by_site, invalid_input, insufficient_credits, incomplete, failed
outcome (anyOf 2)nullAlternative
recipestringRequired within parentKnown values: apply, extract
statusstringRequired within parent
workflow_permanent_idstringRequired within parent
workflow_run_idstringRequired within parentPattern: ^wr_

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.