DocumentationAPI ReferenceChangelog

Envocal API

API Reference API Changelog

Endpoints

Identify the caller GET
Me

Identify the caller

API Changelog

Changes to the Envocal API, newest first. Within v1, changes are backward compatible.

List tenants GET

Every tenant the caller can act on: the key's own tenant and all its sub-tenants, sorted by name.

GET
/v1/me

The API key you are calling with and its tenant. Start here: tenantId is what current stands for in /v1/tenants/current/..., and GET /v1/tenants lists that tenant with all its sub-tenants. Works with any valid key, whatever its permissions.

Required permission: none; any valid API key.

Authorization

Bearer
headerAuthorizationBearer <token>

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

Response Body

The key and its tenant.

  1. response
  1. response
  2. …

The caller of the public API: an API key and its tenant.

keyId?string

Id of the API key.

Formatuuid
name*string

The name the key was given in the Studio.

tenantId*string

The key's own tenant: what current stands for in /v1/tenants/current/....

tenantName*string

Name of that tenant.

scopes*array<string>

The key's permissions, e.g. agents:write.

region*string

Data region the key and its tenant live in, e.g. eu; the same code is in the key (evk_eu_...).

Example Request
curl -X GET 'https://api.envocal.ai/v1/me'
Example Response
{  "keyId": "468bcefd-6536-4844-8249-aff3ecb2ef7b",  "name": "string",  "tenantId": "string",  "tenantName": "string",  "scopes": [    "string"  ],  "region": "string"}
Example Request
curl -X GET 'https://api.envocal.ai/v1/me'
{
  "keyId": "468bcefd-6536-4844-8249-aff3ecb2ef7b",
  "name": "string",
  "tenantId": "string",
  "tenantName": "string",
  "scopes": [
    "string"
  ],
  "region": "string"
}