Client Config

Retrieve client-safe configuration values for embedding in browser-side applications.

The Client Config endpoint returns configuration values that are safe to embed in browser-side code. This is useful for retrieving platform-managed API keys (such as mapping service keys) without exposing backend secrets.

Values returned by this endpoint are restricted by HTTP referrer or similar origin controls at the provider level. They are not general-purpose secrets.

Endpoints

Method
Path
Description

GET

/v1/{workspace_id}/config/client

Get client-safe configuration

Get Client Configuration

GET /v1/{workspace_id}/config/client

Returns client-safe configuration for the authenticated workspace. Requires workspace-level authentication. Rate-limited.

Path Parameters

Parameter
Type
Required
Description

workspace_id

string (UUID)

Yes

Workspace identifier

Response

Field
Type
Description

google_maps_api_key

string or null

Google Maps API key for client-side map rendering. null when not configured. Max length 512 characters.

Example Request

curl -X GET "https://api.platform.amigo.ai/v1/{workspace_id}/config/client" \
  -H "Authorization: Bearer <token>"

Example Response

When no key is configured:

Notes

  • The endpoint requires workspace authentication but returns platform-global configuration. The workspace gate ensures only authenticated callers can retrieve keys.

  • Fields are null when the corresponding value is not configured or is set to a placeholder.

  • Additional client-safe fields may be added to the response in future releases without a version bump. Clients should ignore unknown fields.

Last updated

Was this helpful?