Skyvern: Scripts schemas
6 Skyvern schemas with complete fields and constraints.
← Scripts operations · All schemas
Create script — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
files | JSON | Optional | Array of files to include in the script |
files (anyOf 1) | array | Alternative | |
files (anyOf 1)[] | Model | Each item | Expand Deploy script — request body — body files item |
files (anyOf 2) | null | Alternative | |
run_id | JSON | Optional | Associated run ID |
run_id (anyOf 1) | string | Alternative | |
run_id (anyOf 2) | null | Alternative | |
workflow_id | JSON | Optional | Associated workflow ID |
workflow_id (anyOf 1) | string | Alternative | |
workflow_id (anyOf 2) | null | Alternative |
Referenced models: Deploy script — request body — body files item
Create script — 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 |
file_count | JSON | Required within parent | |
file_count (anyOf 1) | integer | Alternative | Total number of files in the script |
file_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
file_tree | object | Required within parent | Hierarchical file tree structure Additional keys: see wildcard field |
file_tree.* | Model | Additional keys | Expand Create script — response body — file tree value |
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 | Unique script identifier |
version | JSON | Required within parent | |
version (anyOf 1) | integer | Alternative | Script version number |
version (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Create script — response body — file tree value
Create script — response body — file tree value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Model representing a file or directory in the file tree. |
children | JSON | Optional | Child nodes for directories |
children (anyOf 1) | object | Alternative | Additional keys: see wildcard field |
children (anyOf 1).* | Model | Additional keys | Expand Create script — response body — file tree value |
children (anyOf 2) | null | Alternative | |
content_hash | JSON | Optional | SHA256 hash of file content |
content_hash (anyOf 1) | string | Alternative | |
content_hash (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | Timestamp when the file was created Format: date-time |
mime_type | JSON | Optional | MIME type of the file |
mime_type (anyOf 1) | string | Alternative | |
mime_type (anyOf 2) | null | Alternative | |
size | JSON | Optional | File size in bytes |
size (anyOf 1) | JSON | Alternative | |
size (anyOf 1) (anyOf 1) | integer | Alternative | |
size (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
size (anyOf 2) | null | Alternative | |
type | string | Required within parent | Type of node: 'file' or 'directory' |
Referenced models: Create script — response body — file tree value
Deploy script — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request model for deploying a script with updated files. |
files | array | Required within parent | Array of files to include in the script |
files[] | Model | Each item | Expand Deploy script — request body — body files item |
Referenced models: Deploy script — request body — body files item
Deploy script — request body — body files item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Model representing a file in a script. |
content | string | Required within parent | Base64 encoded file content |
encoding | string | Optional | Supported file content encodings. Content encoding One of: base64, utf-8 Default: base64 |
mime_type | JSON | Optional | MIME type (auto-detected if not provided) |
mime_type (anyOf 1) | string | Alternative | |
mime_type (anyOf 2) | null | Alternative | |
path | string | Required within parent | File path relative to script root |
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]+)?$ |