Execute tool

Execute tool

curl --request POST \
  --url https://api.engini.io/v1/tools/{toolSlug}/execute \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fields": {},
  "contextValue": "<string>",
  "filters": [
    {
      "fieldName": "<string>",
      "operator": "<string>",
      "value": "<string>"
    }
  ],
  "sort": [
    {
      "fieldName": "<string>"
    }
  ],
  "offset": 123,
  "top": 123,
  "subItems": {},
  "customConnectionData": [
    {
      "fieldName": "<string>",
      "value": "<string>"
    }
  ]
}
'

import requests

url = "https://api.engini.io/v1/tools/{toolSlug}/execute"

payload = {
    "fields": {},
    "contextValue": "<string>",
    "filters": [
        {
            "fieldName": "<string>",
            "operator": "<string>",
            "value": "<string>"
        }
    ],
    "sort": [{ "fieldName": "<string>" }],
    "offset": 123,
    "top": 123,
    "subItems": {},
    "customConnectionData": [
        {
            "fieldName": "<string>",
            "value": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    fields: {},
    contextValue: '<string>',
    filters: [{fieldName: '<string>', operator: '<string>', value: '<string>'}],
    sort: [{fieldName: '<string>'}],
    offset: 123,
    top: 123,
    subItems: {},
    customConnectionData: [{fieldName: '<string>', value: '<string>'}]
  })
};

fetch('https://api.engini.io/v1/tools/{toolSlug}/execute', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.engini.io/v1/tools/{toolSlug}/execute",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'fields' => [
        
    ],
    'contextValue' => '<string>',
    'filters' => [
        [
                'fieldName' => '<string>',
                'operator' => '<string>',
                'value' => '<string>'
        ]
    ],
    'sort' => [
        [
                'fieldName' => '<string>'
        ]
    ],
    'offset' => 123,
    'top' => 123,
    'subItems' => [
        
    ],
    'customConnectionData' => [
        [
                'fieldName' => '<string>',
                'value' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.engini.io/v1/tools/{toolSlug}/execute"

	payload := strings.NewReader("{\n  \"fields\": {},\n  \"contextValue\": \"<string>\",\n  \"filters\": [\n    {\n      \"fieldName\": \"<string>\",\n      \"operator\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"sort\": [\n    {\n      \"fieldName\": \"<string>\"\n    }\n  ],\n  \"offset\": 123,\n  \"top\": 123,\n  \"subItems\": {},\n  \"customConnectionData\": [\n    {\n      \"fieldName\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.engini.io/v1/tools/{toolSlug}/execute")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fields\": {},\n  \"contextValue\": \"<string>\",\n  \"filters\": [\n    {\n      \"fieldName\": \"<string>\",\n      \"operator\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"sort\": [\n    {\n      \"fieldName\": \"<string>\"\n    }\n  ],\n  \"offset\": 123,\n  \"top\": 123,\n  \"subItems\": {},\n  \"customConnectionData\": [\n    {\n      \"fieldName\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.engini.io/v1/tools/{toolSlug}/execute")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"fields\": {},\n  \"contextValue\": \"<string>\",\n  \"filters\": [\n    {\n      \"fieldName\": \"<string>\",\n      \"operator\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"sort\": [\n    {\n      \"fieldName\": \"<string>\"\n    }\n  ],\n  \"offset\": 123,\n  \"top\": 123,\n  \"subItems\": {},\n  \"customConnectionData\": [\n    {\n      \"fieldName\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "isSuccess": true,
  "errorMessage": "<string>",
  "executionInfo": {
    "statusCode": 123,
    "headers": {},
    "executionTime": 123,
    "dataSize": 123
  },
  "output": "<unknown>",
  "historyId": 123
}

{
  "errorCode": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "timestamp": "<string>",
  "path": "<string>",
  "details": [
    {
      "field": "<string>",
      "issue": "<string>"
    }
  ]
}

{
  "errorCode": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "timestamp": "<string>",
  "path": "<string>",
  "details": [
    {
      "field": "<string>",
      "issue": "<string>"
    }
  ]
}

{
  "errorCode": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "timestamp": "<string>",
  "path": "<string>",
  "details": [
    {
      "field": "<string>",
      "issue": "<string>"
    }
  ]
}

{
  "errorCode": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "timestamp": "<string>",
  "path": "<string>",
  "details": [
    {
      "field": "<string>",
      "issue": "<string>"
    }
  ]
}

{
  "errorCode": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "timestamp": "<string>",
  "path": "<string>",
  "details": [
    {
      "field": "<string>",
      "issue": "<string>"
    }
  ]
}

{
  "errorCode": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "timestamp": "<string>",
  "path": "<string>",
  "details": [
    {
      "field": "<string>",
      "issue": "<string>"
    }
  ]
}

{
  "errorCode": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "timestamp": "<string>",
  "path": "<string>",
  "details": [
    {
      "field": "<string>",
      "issue": "<string>"
    }
  ]
}

POST

tools

{toolSlug}

execute

Execute tool

curl --request POST \
  --url https://api.engini.io/v1/tools/{toolSlug}/execute \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fields": {},
  "contextValue": "<string>",
  "filters": [
    {
      "fieldName": "<string>",
      "operator": "<string>",
      "value": "<string>"
    }
  ],
  "sort": [
    {
      "fieldName": "<string>"
    }
  ],
  "offset": 123,
  "top": 123,
  "subItems": {},
  "customConnectionData": [
    {
      "fieldName": "<string>",
      "value": "<string>"
    }
  ]
}
'

import requests

url = "https://api.engini.io/v1/tools/{toolSlug}/execute"

payload = {
    "fields": {},
    "contextValue": "<string>",
    "filters": [
        {
            "fieldName": "<string>",
            "operator": "<string>",
            "value": "<string>"
        }
    ],
    "sort": [{ "fieldName": "<string>" }],
    "offset": 123,
    "top": 123,
    "subItems": {},
    "customConnectionData": [
        {
            "fieldName": "<string>",
            "value": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    fields: {},
    contextValue: '<string>',
    filters: [{fieldName: '<string>', operator: '<string>', value: '<string>'}],
    sort: [{fieldName: '<string>'}],
    offset: 123,
    top: 123,
    subItems: {},
    customConnectionData: [{fieldName: '<string>', value: '<string>'}]
  })
};

fetch('https://api.engini.io/v1/tools/{toolSlug}/execute', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.engini.io/v1/tools/{toolSlug}/execute",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'fields' => [
        
    ],
    'contextValue' => '<string>',
    'filters' => [
        [
                'fieldName' => '<string>',
                'operator' => '<string>',
                'value' => '<string>'
        ]
    ],
    'sort' => [
        [
                'fieldName' => '<string>'
        ]
    ],
    'offset' => 123,
    'top' => 123,
    'subItems' => [
        
    ],
    'customConnectionData' => [
        [
                'fieldName' => '<string>',
                'value' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.engini.io/v1/tools/{toolSlug}/execute"

	payload := strings.NewReader("{\n  \"fields\": {},\n  \"contextValue\": \"<string>\",\n  \"filters\": [\n    {\n      \"fieldName\": \"<string>\",\n      \"operator\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"sort\": [\n    {\n      \"fieldName\": \"<string>\"\n    }\n  ],\n  \"offset\": 123,\n  \"top\": 123,\n  \"subItems\": {},\n  \"customConnectionData\": [\n    {\n      \"fieldName\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.engini.io/v1/tools/{toolSlug}/execute")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fields\": {},\n  \"contextValue\": \"<string>\",\n  \"filters\": [\n    {\n      \"fieldName\": \"<string>\",\n      \"operator\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"sort\": [\n    {\n      \"fieldName\": \"<string>\"\n    }\n  ],\n  \"offset\": 123,\n  \"top\": 123,\n  \"subItems\": {},\n  \"customConnectionData\": [\n    {\n      \"fieldName\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.engini.io/v1/tools/{toolSlug}/execute")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"fields\": {},\n  \"contextValue\": \"<string>\",\n  \"filters\": [\n    {\n      \"fieldName\": \"<string>\",\n      \"operator\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"sort\": [\n    {\n      \"fieldName\": \"<string>\"\n    }\n  ],\n  \"offset\": 123,\n  \"top\": 123,\n  \"subItems\": {},\n  \"customConnectionData\": [\n    {\n      \"fieldName\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "isSuccess": true,
  "errorMessage": "<string>",
  "executionInfo": {
    "statusCode": 123,
    "headers": {},
    "executionTime": 123,
    "dataSize": 123
  },
  "output": "<unknown>",
  "historyId": 123
}

{
  "errorCode": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "timestamp": "<string>",
  "path": "<string>",
  "details": [
    {
      "field": "<string>",
      "issue": "<string>"
    }
  ]
}

{
  "errorCode": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "timestamp": "<string>",
  "path": "<string>",
  "details": [
    {
      "field": "<string>",
      "issue": "<string>"
    }
  ]
}

{
  "errorCode": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "timestamp": "<string>",
  "path": "<string>",
  "details": [
    {
      "field": "<string>",
      "issue": "<string>"
    }
  ]
}

{
  "errorCode": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "timestamp": "<string>",
  "path": "<string>",
  "details": [
    {
      "field": "<string>",
      "issue": "<string>"
    }
  ]
}

{
  "errorCode": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "timestamp": "<string>",
  "path": "<string>",
  "details": [
    {
      "field": "<string>",
      "issue": "<string>"
    }
  ]
}

{
  "errorCode": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "timestamp": "<string>",
  "path": "<string>",
  "details": [
    {
      "field": "<string>",
      "issue": "<string>"
    }
  ]
}

{
  "errorCode": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "timestamp": "<string>",
  "path": "<string>",
  "details": [
    {
      "field": "<string>",
      "issue": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Enter your JWT token

Path Parameters

toolSlug

string

required

The slug identifying the tool to execute.

Query Parameters

toolsetId

string | null

Optional toolset identifier used to scope connection resolution.

connectionId

integer<int32> | null

Optional explicit connection identifier to use instead of the implicitly resolved connection.

Body

application/json

The execution request containing the tool's input arguments.

Body shape for POST /api/DeveloperAPI/v1/tools/{toolSlug}/execute. activityName is intentionally absent — the activity is resolved from the path slug (+ optional ?applicationSlug=). Connection is resolved implicitly from the caller's account-user, the tool's parent application, and the optional ?toolsetId= query param. See applications-tools-spec.md §"POST /api/DeveloperAPI/v1/tools/{toolSlug}/execute".

fields

object | null

Input field values for the tool, keyed by field name.

Show child attributes

contextValue

string | null

Optional context value passed to the tool.

filters

object[] | null

Filter conditions to apply to the tool's results.

Show child attributes

sort

object[] | null

Sort clauses to apply to the tool's results.

Show child attributes

offset

integer<int32> | null

Number of leading results to skip (pagination offset).

top

integer<int32> | null

Maximum number of results to return.

subItems

object | null

Sub-item input values for the tool, keyed by name.

Show child attributes

customConnectionData

object[] | null

Per-call overrides for the resolved connection's fields; only fields marked overridable are accepted.

Show child attributes

Response

The tool execution result, including success status and any output.

200 response shape for POST /api/DeveloperAPI/v1/tools/{toolSlug}/execute. Tool-runtime failures (downstream API errors) return 200 + IsSuccess=false

ErrorMessage — not the standard error envelope. All non-200 responses use the standard ErrorResponse envelope, not this type. See applications-tools-spec.md §"Response 200".

isSuccess

boolean

required

Whether the tool executed successfully. When false, see ErrorMessage.

errorMessage

string | null

Human-readable failure reason when IsSuccess is false; otherwise null.

executionInfo

object | null

Metadata about the execution (HTTP status, headers, timing, payload size).

Show child attributes

output

any | null

The tool's result payload. Intentionally free-form (any JSON): its shape is defined by the individual tool's output schema, not by this envelope (api-spec-feedback.md C3).

historyId

integer<int32> | null

Identifier of the workflow-history record for this execution, when one was created.

⌘I

Overview

Endpoints

Authorizations

Path Parameters

Query Parameters

Body

Response