Developer Settings

Manage workspace developer settings including preview URL overrides for staging environments.

Developer settings let internal developers configure preview URL overrides for a workspace. When a preview URL is set, clients can route API requests through a preview deployment of the platform API for staging validation.

Write access to developer settings is restricted to users with Amigo email addresses and requires a user identity token - API key authentication is not supported for writes. Read access is available to any authenticated user.

Endpoints

Method	Path	Description
GET	/v1/{workspace_id}/settings/developer	Get developer settings
PUT	/v1/{workspace_id}/settings/developer	Update developer settings

Get Developer Settings

GET /v1/{workspace_id}/settings/developer

Returns the current developer settings for the workspace. Returns an empty configuration when no developer settings have been configured.

Response body:

Field	Type	Description
developer	object	Developer settings object
developer.preview_platform_api_url	string or null	Preview platform API URL override. null when not configured.

Example response:

{
  "developer": {
    "preview_platform_api_url": "https://preview-123.platform.amigo.ai"
  }
}

Response when not configured:

{
  "developer": {
    "preview_platform_api_url": null
  }
}

Update Developer Settings

PUT /v1/{workspace_id}/settings/developer

Updates the developer settings for the workspace. Requires a user identity token with an Amigo email address. API key authentication is not supported.

Request body:

Field	Type	Required	Description
developer	object	Yes	Developer settings object
developer.preview_platform_api_url	string or null	No	Preview platform API URL. Must match https://<subdomain>.platform.amigo.ai. Set to null to clear. Maximum 500 characters.

Example request:

{
  "developer": {
    "preview_platform_api_url": "https://preview-123.platform.amigo.ai"
  }
}

To clear the preview URL:

{
  "developer": {
    "preview_platform_api_url": null
  }
}

Response: Same shape as the GET response, reflecting the updated settings.

Error responses:

Status	Description
401	User identity token required - API key authentication is not supported
403	Not an Amigo account - only Amigo email addresses can modify developer settings
404	Workspace not found
422	Validation error - URL does not match the required pattern
429	Rate limited