Skip to main content
The Vantage API allows you to access Document skill and Process skill parameters and change their values for a particular transaction. Skill parameters passed in a transaction consist of key-value string pairs. For Document and Process skill parameters, values set via the Vantage API will have priority over those set via the Vantage UI.

​
Changing Skill Parameter Values

To change skill parameter values via the Vantage API, do the following:

​
Step 1: Create or Initialize a Transaction

Create an empty transaction or initialize a transaction using the launch method. To do so, send a POST request to the transactions resource: 
POST {your-host}/api/publicapi/v1/transactions
or 
POST {your-host}/api/publicapi/v1/transactions/launch?skillId={skill-id}
In the request body, specify new values for the skill parameters and run the following command:

​
Windows Example

curl -X POST "{your-host}/api/publicapi/v1/transactions" ^
-H "Authorization: Bearer {token}" ^
-H "Content-Type: application/json" ^
-d "{\"skillId\":\"123\",\"skillParameters\":[{\"key\":\"New parameter\",\"value\":\"Vendors new\"}]}"

​
Linux Example

curl -X POST '{your-host}/api/publicapi/v1/transactions' \
-H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/json' \
-d '{"skillId":"123","skillParameters":[{"key":"New parameter","value":"Vendors new"}]}'
Note: There can be a maximum of 10 key-value skill parameters, with each key containing up to 128 characters and each value containing up to 256 characters.

​
Getting Skill Parameter Values

To get skill parameter values using the Vantage API, do one of the following:

​
Option 1: Get Skill Parameters Directly

Send a GET request to the transactions/{transaction-id}/skillParameters resource: 
GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/skillParameters/
The response will look like: 
[
  {
    "key": "New parameter",
    "value": "Vendors"
  }
]

​
Option 2: Download Transaction Files

Send a GET request to the transactions/{transaction-id}/files/{file-id}/download resource to get the values in JSON format: 
GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/files/{file-id}/download