Access skill parameters via the Vantage API

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 or launch a transaction with a POST request. Include the new values in the skillParameters field of the request body. To create an empty transaction, send:

POST {your-host}/api/publicapi/v1/transactions

To launch a transaction that runs a specific skill, send:

POST {your-host}/api/publicapi/v1/transactions/launch?skillId={skill-id}

The following example includes new parameter values in the request body:

Windows
Linux

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\"}]}"

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, and values to 256 characters.

Get skill parameter values

Use one of the following methods to retrieve skill parameter values.

Query the skillParameters endpoint

Send a GET request:

GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/skillParameters/

Example 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

​Change skill parameter values

​Get skill parameter values

​Query the skillParameters endpoint

​Download the transaction file

​Related topics

Change skill parameter values

Get skill parameter values

Query the skillParameters endpoint

Download the transaction file

Related topics