Summary

This section explains how to execute maps out of  Kaholo’s platform using REST API.

How to Authenticate

In order to retrieve the Authorization header you, first you need to make POST request to the login endpoint:

 
curl -X POST \
<YOUR_URL>/api/auth/login \
-H 'accept: application/json' \
-H 'content-type: application/json' \
-d '{
"email": "<YOUR_EMAIL>",
"password": "<YOUR_PASSWORD>"
}'

The response will contain an Authorization header, which you need to send with every request to the REST API.

 

How to Execute

In order to execute a map, you will need to send a POST request to:

Url:

POST <YOUR_URL>/api/maps/<MAP_ID>/execute

Body:

{
"trigger" : "TRIGGER_MESSAGE",
"config" : "CONFIGURATION"
"agents" : ["AGENT1_NAME"]
}

trigger: Custom message to be displayed on the execution
config (optional): name of the configuration to use or custom object to override all configurations
agents (optional): Overrides the agents connected to the map, allows to specify the names of the agents to execute the pipeline on.

Close Menu