SKskyvern-ai
Scripts

Deploy script

Changed on

Deploy a script with updated files, creating a new version

post/v1/scripts/{script_id}/deploy

Request

  • Base URL
    https://api.skyvern.com
  • URL
    https://api.skyvern.com/v1/scripts/{script_id}/deploy
  • Auth
    API key in header x-api-key

Path parameters

script_idstring required

The unique identifier of the script

Example:s_abc123

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

  • 539f04093540Revision changes
    • warning

      deleted the header request parameter x-api-key

    • info

      the endpoint scheme security ApiKeyAuth was added to the API

  • 3a3616091b66Revision changes
    • breaking

      the request property // became not nullable

    • breaking

      response property file_tree/additionalProperties/children list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property file_tree/additionalProperties/content_hash list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property file_tree/additionalProperties/mime_type list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property file_tree/additionalProperties/size list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property run_id list-of-types was widened by adding types null to media type application/json of response 200

    • info

      header request parameter x-api-key list-of-types was widened by adding types null

    • info

      for the header request parameter x-api-key, the type was generalized from string to no type

    • info

      request property // list-of-types was widened by adding types null to media type application/json

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status