Skip to main content
The Vantage API lets you access Document and Process skill parameters and change their values for a specific transaction. Parameters are passed as key-value string pairs. Values set via the API take precedence over values set in the Vantage UI.

​
Change skill parameter values

To change skill parameter values for a transaction, create a new transaction (or launch one) via POST and include the new values in the skillParameters body. Create an empty transaction: 
POST {your-host}/api/publicapi/v1/transactions
Or launch a transaction that runs a specific skill: 
POST {your-host}/api/publicapi/v1/transactions/launch?skillId={skill-id}
Include new parameter values in the request body: 
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\"}]}"
A transaction can have up to 10 key-value skill parameters. Keys are limited to 128 characters; values to 256.

​
Get skill parameter values

Use one of the following to retrieve skill parameter values.

​
Query the skillParameters endpoint

Send a GET request: 
GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/skillParameters/
Response: 
[
  {
    "key": "New parameter",
    "value": "Vendors"
  }
]

​
Download the transaction file

Send a GET request to download the transaction file, which contains parameter values in JSON: 
GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/files/{file-id}/download