Scripts

Deploy script

Deploy a script with updated files, creating a new version

post/v1/scripts/{script_id}/deploy

Path parameters

script_idstring required

The unique identifier of the script

Example:s_abc123

The unique identifier of the script

Headers

x-api-keystring nullable

Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.

Request body

Example request

{
  "files": [
    {
      "path": "src/main.py"
    }
  ]
}

Response

Successful Response

script_idstring required

Unique script identifier

versioninteger required

Script version number

run_idstring nullable

ID of the workflow run or task run that generated this script

file_countinteger required

Total number of files in the script

file_treeobject required

Hierarchical file tree structure

created_atstring date-time required

Timestamp when the script was created

Example response

{
  "script_id": "s_abc123",
  "version": 1
}

Changes

Changed in 2 of the 86 revisions of this API.66

Jun 8, 20263a3616091b6665See the full diff
- ▲
  the request property // became not nullable
  request-property-became-not-nullable
- ▲
  response property file_tree/additionalProperties/children list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property file_tree/additionalProperties/content_hash list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property file_tree/additionalProperties/mime_type list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property file_tree/additionalProperties/size list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property run_id list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ○
  header request parameter x-api-key list-of-types was widened by adding types null
  request-parameter-list-of-types-widened
- ○
  for the header request parameter x-api-key, the type was generalized from string to no type
  request-parameter-type-generalized
- ○
  request property // list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 4, 2026a8899e7707c41See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history