Tools
The tools the tenant has made for its agents, newest first. Give a tool to an agent with
PUT /v1/tenants/{tenantId}/agents/{id}/tools, using the tool's id.
Required permission: tools:read
BearerAuthorizationBearer <token>Tenant API key (evk_…), created in Studio → Vault → API keys.
tenantId*stringTenant id, or current for the key's own tenant. Must be the key's tenant or one of its sub-tenants.
The tools.
[index: integer]?A tool a tenant's agents can use: an HTTP request, the variables it needs and the credential it authenticates with.
curl -X GET 'https://api.envocal.ai/v1/tenants/string/tools'[ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "tenantId": "string", "kind": "string", "name": "string", "displayName": "string", "description": "string", "preToolSpeech": "string", "availability": [ "before" ], "channels": [ "chat" ], "visibility": "private", "credentialType": "string", "credentialId": "f568fec0-10b6-4b94-9daf-e62c50c9bf3e", "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" } ] }, "revision": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }]curl -X GET 'https://api.envocal.ai/v1/tenants/string/tools'[
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tenantId": "string",
"kind": "string",
"name": "string",
"displayName": "string",
"description": "string",
"preToolSpeech": "string",
"availability": [
"before"
],
"channels": [
"chat"
],
"visibility": "private",
"credentialType": "string",
"credentialId": "f568fec0-10b6-4b94-9daf-e62c50c9bf3e",
"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"
}
]
},
"revision": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]