Run a script

Scripts can be run with a POST API call using your Run Script API Key and Secret to authenticate. Use the body of the POST to control input & output files and script arguments.

To better support job dispatching requirements and provide enhanced features, we are introducing a new version of the Job API. For more info, please refer to the latest API version, /api/v2/job introduction

Request body

Key	Type	Description
inputs	array of file objects	{href: S3 Presigned getObject URL, path: local path to store file}
outputs	array of file objects	{href: S3 Presigned putObject URL, path: local path to store file}
args	array of arg objects	{name: string, value: string}
script	string	InDesign script
webhook	url	url receives a POST with job data every time a job changes status
errorOnTransferFail	boolean	Throw error when uploads/downloads fail
ids	string	Optional parameter to slect Indesign instance. Only available on api/v2

Request example api/v1

var axios = require('axios');
var data = {
  "inputs": [
    {
      "href": "https://example.s3.us-east-1.amazonaws.com.....", // S3 Presigned getObject URL 
      "path": "jobFolder/input.indd" // Path to store file
    }
	],
  "outputs": [
    {
      "href": "https://example.s3.us-east-1.amazonaws.com....." // S3 Presigned putObject URL 
      "path": "jobFolder/output.pdf", // Path to store file			
    }
  ],
  "args": [
    {
      "name": "count",
      "value": "100"
    }
  ],
  "script": "app.consoleout('test');",
};

var runscriptApiKey = '5d6c6298de22d$$83f5180f4'; // Your API key
var runscriptApiSecret = '2b108tRnVwK2VDG8qJGpLZWRredLmL2dljBaywkOIlPR2YmO9QWq1DwRy'; // Your API Secret
var auth = {username: runscriptApiKey, password: runscriptApiSecret};
var url = 'https://runscript.typefi.com/api/v1/job'
var response = await axios.post(url, data, {auth: auth});

Request example api/v2

var axios = require('axios');
var data = {
  "inputs": [
    {
      "href": "https://example.s3.us-east-1.amazonaws.com.....", // S3 Presigned getObject URL 
      "path": "jobFolder/input.indd" // Path to store file
    }
	],
  "outputs": [
    {
      "href": "https://example.s3.us-east-1.amazonaws.com....." // S3 Presigned putObject URL 
      "path": "jobFolder/output.pdf", // Path to store file			
    }
  ],
  "args": [
    {
      "name": "count",
      "value": "100"
    }
  ],
  "script": "app.consoleout('test');",
  "ids":"2024"
};

var runscriptApiKey = '5d6c6298de22d$$83f5180f4'; // Your API key
var runscriptApiSecret = '2b108tRnVwK2VDG8qJGpLZWRredLmL2dljBaywkOIlPR2YmO9QWq1DwRy'; // Your API Secret
var auth = {username: runscriptApiKey, password: runscriptApiSecret};
var url = 'https://runscript.typefi.com/api/v2/job'
var response = await axios.post(url, data, {auth: auth});

Response

{
  "_id": "5d71b313eef1c01dcb997s1e",
  "status": "queued",    
  "created": "2019-09-06T01:15:00.007Z",
  "script": "...",
  "inputs": [
    ...
  ],
  "outputs": [
    ...
  ],
  "args": [
    ...
  ],    
}

Get a jobs status

You can manually poll a job to check its status using a GET API call with the job id in the url.

Key	Type	Description
status	string	current status: queued, inProgress, complete, failed or canceled
result	string	completed result: success, canceled or failed
completed	date	when the job completed
runTime	integer	time the job ran for in milliseconds

Request example api/v1

var runscriptApiKey = '5d6c6298de22d$$83f5180f4'; // Your API key
var runscriptApiSecret = '2b108tRnVwK2VDG8qJGpLZWRredLmL2dljBaywkOIlPR2YmO9QWq1DwRy'; // Your API Secret
var jobId = '5d71b313eef1c01dcb997s1e';
var auth = {username: runscriptApiKey, password: runscriptApiSecret};
var url = 'https://runscript.typefi.com/api/v1/job/' + jobId;
var response = await axios.get(url, {auth: auth});

Response

{
  "_id": "5d71b313eef1c01dcb997s1e",
  "status": "complete",    
  "created": "2019-09-09T00:09:30.489Z",
  "completed": "2019-09-09T00:09:33.929Z",
  "result": "success",
  "runTime": 2862,
  "script": "...",
  "inputs": [
    ...
  ],
  "outputs": [
    ...
  ],
  "args": [
    ...
  ],    
}

Request example api/v2

var runscriptApiKey = '5d6c6298de22d$$83f5180f4'; // Your API key
var runscriptApiSecret = '2b108tRnVwK2VDG8qJGpLZWRredLmL2dljBaywkOIlPR2YmO9QWq1DwRy'; // Your API Secret
var jobId = '5d71b313eef1c01dcb997s1e';
var auth = {username: runscriptApiKey, password: runscriptApiSecret};
var url = 'https://runscript.typefi.com/api/v2/job/' + jobId;
var response = await axios.get(url, {auth: auth});

Response

{
  "_id": "5d71b313eef1c01dcb997s1e",
  "status": "complete",    
  "created": "2019-09-09T00:09:30.489Z",
  "completed": "2019-09-09T00:09:33.929Z",
  "result": "success",
  "runTime": 2862,
  "script": "...",
  "inputs": [
    ...
  ],
  "outputs": [
    ...
  ],
  "args": [
    ...
  ],    
}

File inputs & outputs

You need to list the files that will be inputs from S3 to the InDesignContainer and also the files that will be outputs from the InDesignContainer to S3. This is done using a S3 Presigned URL.

var AWS = require("aws-sdk");
var s3region = 'example-region-1';
var s3accessKeyId = 'EXAMPLE_ACCESS_KEY';
var s3secretAccessKey = 'EXAMPLE_SECRET_ACCESS_KEY';
var s3bucket = 'example-bucket';

var s3 = new AWS.S3({ region: s3region, accessKeyId: s3accessKeyId, secretAccessKey: s3secretAccessKey});

// Create an input file 
var inputFile1 = {};
inputFile1.href = await s3.getSignedUrl('getObject', {Bucket: s3bucket, Key: 'folder/example.txt'}); // must match existing file on s3
inputFile1.path = 'jobFolder/example.txt';

// Create an out file
var outputFile1 = {};
outputFile1.href = await s3.getSignedUrl('putObject', {Bucket: s3bucket, Key: 'folder/example.txt', ContentType: 'application/octet-stream'}); // ContentType must be application/octet-stream  
outputFile1.path = 'jobFolder/example.txt';

var inputs = [
  inputFile1
];

var outputs = [
  outputFile1
];

Script example

var currentPath = Folder.current; // The root path usually "c:/"
File example = new File('jobFolder/example.txt'); // File path is relative

Script arguments

Run Script passes arguments to InDesign Servers scriptArgs which can be accessed from your scripts. *All values are type string

Request body

{
  "args": [
    {
      "name": "foo",
      "value": "bar"
    },
    {
      "name": "count",
      "value": 123
    }
  ]
}

Script example

if(app.scriptArgs.isDefined("foo") == true){
  var foo = app.scriptArgs.getValue("foo"); // returns "bar"
}
if(app.scriptArgs.isDefined("count") == true){
  var count = app.scriptArgs.getValue("count"); // returns "123"
}

Webhook

Instead of polling RunScript with GET calls to track job status you can use a webhook. A webhook is a url that recieves a POST with the job object every time the job status changes. The webhook could also be used to notify extenal applications like Slack or GitHub.

Request body

{
  "inputs": [
    ...
  ],
  "outputs": [
    ...
  ],
  "script": "...",
  "webhook": "https://hooks.zapier.com/hooks/catch/24234234/example/"
}

Response body

{
  "_id": "5d71b313eef1c01dcb997s1e",
  "status": "inProgress",    
  "created": "2019-09-09T00:09:30.489Z",
  "script": "...",
  "inputs": [
    ...
  ],
  "outputs": [
    ...
  ],
  "webhook": "https://hooks.zapier.com/hooks/catch/24234234/example/"
}