DocumentationAPI ReferenceChangelog

Envocal API

API Reference Tools guide MCP server API Changelog

Endpoints

List tools GETCreate a tool POSTGet a tool GETDelete a tool DELETEUpdate a tool PUTTest a tool POSTList tool templates GETCreate a tool from a template POST
Tools

List tool templates

Test a tool POST

Sends the tool's real request once, with the variable values you give, and returns what the other system answered: as an agent would call it in a conversation. This reaches the other system for real, so a tool that changes something there changes it.

Create a tool from a template POST

Copies a tool template into a new private tool of the tenant: the request with its static values, the variables, the response mapping, phases, channels and the credential type. The credential and the vault secrets are not copied: set credentialId, and secretId on each header that takes a secret, on the new tool with PUT /v1/tenants/{tenantId}/tools/{id}.

GET
/v1/tenants/{tenantId}/tool-templates

Tools the tenant can copy: the ones the tenant itself and the tenants above it have set to shared. Make a copy with POST /v1/tenants/{tenantId}/tool-templates/{templateId}/instantiate.

Required permission: tools:read

Authorization

Bearer
headerAuthorizationBearer <token>

Tenant API key (evk_…), created in Studio → Vault → API keys.

Path Parameters

tenantId*string

Tenant id, or current for the key's own tenant. Must be the key's tenant or one of its sub-tenants.

Response Body

The templates, sorted by display name.

  1. response
  1. response
  2. …
[index: integer]?

A shared tool that a tenant can copy into a tool of its own.

Example Request
curl -X GET 'https://api.envocal.ai/v1/tenants/string/tool-templates'
Example Response
[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "tenantId": "string",    "tenantName": "string",    "name": "string",    "displayName": "string",    "description": "string",    "preToolSpeech": "string",    "availability": [      "before"    ],    "channels": [      "chat"    ],    "credentialType": "string",    "config": {      "schemaVersion": 0,      "http": {        "method": "GET",        "url": "string",        "timeoutSeconds": 0,        "headers": [          {            "key": "string",            "name": "string",            "type": "string",            "inputType": "static",            "value": "string",            "varName": "string",            "secretId": "c39edb4b-1d7b-4287-b1be-9dcaba334a25",            "template": "string"          }        ],        "query": [          {            "key": "string",            "name": "string",            "type": "string",            "inputType": "static",            "value": "string",            "varName": "string",            "secretId": "c39edb4b-1d7b-4287-b1be-9dcaba334a25",            "template": "string"          }        ],        "path": [          {            "key": "string",            "name": "string",            "type": "string",            "inputType": "static",            "value": "string",            "varName": "string",            "secretId": "c39edb4b-1d7b-4287-b1be-9dcaba334a25",            "template": "string"          }        ],        "body": {          "rootKind": "object",          "nodes": [            {              "id": "string",              "name": "string",              "type": "string",              "inputType": "static",              "value": "string",              "varName": "string",              "template": "string",              "children": [                {}              ]            }          ]        },        "bodyTransform": {          "type": "mimeEmail",          "encoding": "base64",          "output": {            "mode": "jsonPath",            "path": "string"          }        }      },      "variables": {        "agent": [          {            "name": "string",            "description": "string",            "jsonType": "string",            "enums": [              null            ],            "example": "string",            "required": true          }        ],        "dynamic": [          {            "name": "string",            "jsonType": "string",            "description": "string",            "placeholder": "string"          }        ]      },      "responseMapping": [        {          "dynamicVar": "string",          "jsonPath": "string"        }      ]    }  }]
GET
/v1/tenants/{tenantId}/tool-templates
Example Request
curl -X GET 'https://api.envocal.ai/v1/tenants/string/tool-templates'
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "tenantId": "string",
    "tenantName": "string",
    "name": "string",
    "displayName": "string",
    "description": "string",
    "preToolSpeech": "string",
    "availability": [
      "before"
    ],
    "channels": [
      "chat"
    ],
    "credentialType": "string",
    "config": {
      "schemaVersion": 0,
      "http": {
        "method": "GET",
        "url": "string",
        "timeoutSeconds": 0,
        "headers": [
          {
            "key": "string",
            "name": "string",
            "type": "string",
            "inputType": "static",
            "value": "string",
            "varName": "string",
            "secretId": "c39edb4b-1d7b-4287-b1be-9dcaba334a25",
            "template": "string"
          }
        ],
        "query": [
          {
            "key": "string",
            "name": "string",
            "type": "string",
            "inputType": "static",
            "value": "string",
            "varName": "string",
            "secretId": "c39edb4b-1d7b-4287-b1be-9dcaba334a25",
            "template": "string"
          }
        ],
        "path": [
          {
            "key": "string",
            "name": "string",
            "type": "string",
            "inputType": "static",
            "value": "string",
            "varName": "string",
            "secretId": "c39edb4b-1d7b-4287-b1be-9dcaba334a25",
            "template": "string"
          }
        ],
        "body": {
          "rootKind": "object",
          "nodes": [
            {
              "id": "string",
              "name": "string",
              "type": "string",
              "inputType": "static",
              "value": "string",
              "varName": "string",
              "template": "string",
              "children": [
                {}
              ]
            }
          ]
        },
        "bodyTransform": {
          "type": "mimeEmail",
          "encoding": "base64",
          "output": {
            "mode": "jsonPath",
            "path": "string"
          }
        }
      },
      "variables": {
        "agent": [
          {
            "name": "string",
            "description": "string",
            "jsonType": "string",
            "enums": [
              null
            ],
            "example": "string",
            "required": true
          }
        ],
        "dynamic": [
          {
            "name": "string",
            "jsonType": "string",
            "description": "string",
            "placeholder": "string"
          }
        ]
      },
      "responseMapping": [
        {
          "dynamicVar": "string",
          "jsonPath": "string"
        }
      ]
    }
  }
]