Create draft script version

Add a version to a script as a draft: it does not become the version the script runs until you promote it.

post/api/scripts/{handle}/{host}/{slug}/versions

Request

  • Base URL: https://reduck.ai
  • URL: https://reduck.ai/api/scripts/{handle}/{host}/{slug}/versions
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

handlestring required

The owner a resource is addressed under: "@username" for a personal scope, or a bare slug for a project.

hoststring required

The site the script automates, as a hostname.

slugstring required

The script's unique identifier within its host, unique per owner.

Request body

contentstring
language'typescript' | 'javascript'
parent_version_idstring uuid

The version this draft continues from. It must belong to this script.

notestring required
input_schemaobject
output_schemaobject
logged_inboolean
side_effects'none' | 'write'

What running this version does to the site: none only reads, write acts on it. Declared by the author and never enforced, so treat it as a claim, not a guarantee.

Response

Created

idstring required
script_idstring required
version_numbernumber required
parent_version_idstring nullable required
languagestring required
logged_inboolean required
side_effects'none' | 'undetermined' | 'write' required
draftboolean required
notestring nullable

Why this version exists. Omitted on an official script unless you belong to the project that owns it, and never carried by the version a script listing embeds.

created_atstring required
execution_countnumber required
last_run_atstring nullable required
success_ratenumber nullable required
avg_time_msnumber nullable required
contentstring

The version's source. Omitted on an official script unless you belong to the project that owns it.

input_schemaobject required
output_schemaobject required
librariesstring[]

The libraries the code imports, by host (lib:<host>). Read from the code, so withheld with it on an official script from anyone outside the project that owns it.

Changes

No recorded changes to this operation across all 1 revision of this API.