Skip to main content

Using environment clients

Environment clients are the "connection" between Enterspeed and your front-end and, as the name suggests, it is also tied up to one of your environments.

info

You can only have one environment per environment client.

Moreover, environment clients also have domains attached to them, which makes it possible to filter your data based on the host names attached to the domain name.

However, unlike environments, you can have as many domains attached to your environment client as you wish, but you will need at least one.

info

An environment client won't work without a domain attached to it.

You can also choose to have a single environment client per domain if you have multiple sites, for instance for separation of concern.

Creating an environment

Click the Settings-tab and then click the Environment settings-tab in the sidemenu. Scroll down to Domains and click the Create-button.

Give your Environment client a name and select an environment.

Next, select the domains you wish to add to the environment client and then click Save changes.

Environment clients

Once the environment client has been created an API key will be available. If needed the key can be regenerated by clicking the three dots next to the environment client (Settings) and selecting Regenerate API Key.

API Scopes

API scopes allow you to control which Enterspeed APIs your environment client can access, following the principle of least privilege. This is particularly useful when integrating with AI agents or third-party services where you want to limit access to only the necessary endpoints.

Default Scopes

When creating a new environment client, it automatically receives these default scopes:

  • Delivery API - Access to content delivery endpoints
  • Query API - Access to transformed data (schema-based queries)
  • Routes API - Access to route management and execution

Available Scopes

ScopeDescriptionRequirements
Delivery APIContent delivery endpointsNone
Query APIAccess transformed data (schema-based)None
Routes APIRoutes API accessNone
Source APIAccess raw source data (auto-indexed)None
MCP Server (AI Agent Access)Enables MCP tool endpoints for AI agentsRequires Query API and/or Source API
info

The MCP Server scope is designed for AI agents and does not provide data access by itself. It must be combined with Query API and/or Source API scopes to function properly.

Scope Presets

For convenience, the Management App provides several preset configurations:

  • Standard - Delivery + Routes + Query (default for regular applications)
  • AI Assistant (Transformed Data) - Query + MCP Server (for AI agents using schema-based data)
  • AI Assistant (Source Data) - Source + MCP Server (for AI agents using raw source data)
  • AI Assistant (Full Access) - Query + Source + MCP Server (for AI agents requiring complete data access)
  • Custom - Manually select specific scopes

Managing Scopes

You can configure scopes when creating or updating an environment client through the Management App. Existing environment clients without explicit scopes will continue to work with the default scope configuration, ensuring backward compatibility.