Settings

Get retention policy

get

Get the workspace retention policy.

Returns HIPAA-compliant defaults (2190 days / 6 years) for any field not explicitly configured. Advisory in v1 — no automated deletion.

Permissions: authenticated (any role).

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Responses

200

Successful Response

application/json

call_recordings_daysintegerRequired

call_transcripts_daysintegerRequired

audit_log_daysintegerRequired

world_events_daysintegerRequired

phi_data_daysintegerRequired

legal_holdbooleanRequired

legal_hold_reasonstring · nullableOptional

429

Rate limited

get/v1/{workspace_id}/settings/retention

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/settings/retention HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "call_recordings_days": 1,
  "call_transcripts_days": 1,
  "audit_log_days": 1,
  "world_events_days": 1,
  "phi_data_days": 1,
  "legal_hold": true,
  "legal_hold_reason": "text"
}

Update retention policy

put

Update the workspace retention policy.

Partial updates supported — only provided fields are changed. Advisory in v1: policy is stored and displayed but no automated deletion is performed. Legal hold overrides all retention.

Permissions: admin, owner (Workspace.update).

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Body

application/json

call_recordings_daysinteger · min: 365 · max: 36500 · nullableOptional

call_transcripts_daysinteger · min: 365 · max: 36500 · nullableOptional

audit_log_daysinteger · min: 365 · max: 36500 · nullableOptional

world_events_daysinteger · min: 365 · max: 36500 · nullableOptional

phi_data_daysinteger · min: 365 · max: 36500 · nullableOptional

legal_holdboolean · nullableOptional

legal_hold_reasonstring · max: 2000 · nullableOptional

Responses

200

Successful Response

application/json

call_recordings_daysintegerRequired

call_transcripts_daysintegerRequired

audit_log_daysintegerRequired

world_events_daysintegerRequired

phi_data_daysintegerRequired

legal_holdbooleanRequired

legal_hold_reasonstring · nullableOptional

404

Workspace not found

422

Validation error

429

Rate limited

put/v1/{workspace_id}/settings/retention

HTTPcURLJavaScriptPython

PUT /v1/{workspace_id}/settings/retention HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 156

{
  "call_recordings_days": 1,
  "call_transcripts_days": 1,
  "audit_log_days": 1,
  "world_events_days": 1,
  "phi_data_days": 1,
  "legal_hold": true,
  "legal_hold_reason": "text"
}

{
  "call_recordings_days": 1,
  "call_transcripts_days": 1,
  "audit_log_days": 1,
  "world_events_days": 1,
  "phi_data_days": 1,
  "legal_hold": true,
  "legal_hold_reason": "text"
}

Get gap scanner settings

get

Get the workspace gap scanner settings.

Returns defaults when not configured. Gap scanner is disabled by default.

Permissions: authenticated (any role).

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Responses

200

Successful Response

application/json

enabledbooleanRequired

scan_interval_secondsintegerRequired

appointment_lookahead_hoursintegerRequired

cooldown_hoursintegerRequired

max_surfaces_per_tickintegerRequired

max_pending_surfacesintegerRequired

min_completion_ratenumberRequired

channel_optimizationbooleanRequired

429

Rate limited

get/v1/{workspace_id}/settings/gap-scanner

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/settings/gap-scanner HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "enabled": true,
  "scan_interval_seconds": 1,
  "appointment_lookahead_hours": 1,
  "cooldown_hours": 1,
  "max_surfaces_per_tick": 1,
  "max_pending_surfaces": 1,
  "min_completion_rate": 1,
  "channel_optimization": true,
  "requirements": [
    {
      "name": "text",
      "entity_type": "person",
      "trigger": "upcoming_appointment",
      "required_fields": [
        {
          "path": "text",
          "label": "text",
          "field_type": "text",
          "min_items": 1
        }
      ],
      "channel": "email",
      "priority": "normal",
      "surface_title": "text",
      "surface_description": "text"
    }
  ]
}

Update gap scanner settings

put

Update the workspace gap scanner settings.

Partial updates supported — only provided fields are changed. Requirements list is replaced entirely when provided (not merged).

Permissions: admin, owner (enforced via Workspace.update, matching the outreach-settings sibling).

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Body

application/json

enabledboolean · nullableOptional

scan_interval_secondsinteger · min: 60 · max: 86400 · nullableOptional

appointment_lookahead_hoursinteger · min: 1 · max: 720 · nullableOptional

cooldown_hoursinteger · min: 1 · max: 8760 · nullableOptional

max_surfaces_per_tickinteger · min: 1 · max: 100 · nullableOptional

max_pending_surfacesinteger · max: 50 · nullableOptional

Max non-terminal surfaces per entity (0 = disabled)

min_completion_ratenumber · max: 1 · nullableOptional

Min historical completion rate to create new surfaces (0.0 = disabled)

channel_optimizationboolean · nullableOptional

Use entity preferred channel over static requirement channel

Responses

200

Successful Response

application/json

enabledbooleanRequired

scan_interval_secondsintegerRequired

appointment_lookahead_hoursintegerRequired

cooldown_hoursintegerRequired

max_surfaces_per_tickintegerRequired

max_pending_surfacesintegerRequired

min_completion_ratenumberRequired

channel_optimizationbooleanRequired

404

Workspace not found

422

Validation error

429

Rate limited

put/v1/{workspace_id}/settings/gap-scanner

HTTPcURLJavaScriptPython

PUT /v1/{workspace_id}/settings/gap-scanner HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 460

{
  "enabled": true,
  "scan_interval_seconds": 1,
  "appointment_lookahead_hours": 1,
  "cooldown_hours": 1,
  "max_surfaces_per_tick": 1,
  "max_pending_surfaces": 1,
  "min_completion_rate": 1,
  "channel_optimization": true,
  "requirements": [
    {
      "name": "text",
      "entity_type": "person",
      "trigger": "upcoming_appointment",
      "required_fields": [
        {
          "path": "text",
          "label": "text",
          "field_type": "text",
          "min_items": 1
        }
      ],
      "channel": "email",
      "priority": "normal",
      "surface_title": "text",
      "surface_description": "text"
    }
  ]
}

{
  "enabled": true,
  "scan_interval_seconds": 1,
  "appointment_lookahead_hours": 1,
  "cooldown_hours": 1,
  "max_surfaces_per_tick": 1,
  "max_pending_surfaces": 1,
  "min_completion_rate": 1,
  "channel_optimization": true,
  "requirements": [
    {
      "name": "text",
      "entity_type": "person",
      "trigger": "upcoming_appointment",
      "required_fields": [
        {
          "path": "text",
          "label": "text",
          "field_type": "text",
          "min_items": 1
        }
      ],
      "channel": "email",
      "priority": "normal",
      "surface_title": "text",
      "surface_description": "text"
    }
  ]
}

Preview gap detection (dry run)

post

Dry-run gap detection — returns entities with missing fields without creating surfaces.

Proxies to connector-runner /internal/gap-scanner/preview.

Permissions: admin, owner (enforced via Workspace.update).

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Body

application/json

limitinteger · min: 1 · max: 200OptionalDefault: 50

Responses

200

Successful Response

application/json

Other propertiesanyOptional

422

Validation Error

application/json

429

Rate limited

503

Connector runner unavailable

post/v1/{workspace_id}/settings/gap-scanner/preview

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/settings/gap-scanner/preview HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 12

{
  "limit": 50
}

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Trigger one scan tick

post

Trigger one scan tick immediately — creates surfaces for detected gaps.

Proxies to connector-runner /internal/gap-scanner/scan.

Permissions: admin, owner (enforced via Workspace.update — this creates patient-facing surfaces, so it must not be reachable below admin tier).

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Responses

200

Successful Response

application/json

Other propertiesanyOptional

429

Rate limited

503

Connector runner unavailable

post/v1/{workspace_id}/settings/gap-scanner/scan

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/settings/gap-scanner/scan HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get metric definitions

get

Get the workspace metric definitions.

Returns built-in defaults when not configured.

Permissions: authenticated (any role).

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Responses

200

Successful Response

application/json

429

Rate limited

get/v1/{workspace_id}/settings/metrics

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/settings/metrics HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "definitions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "key": "text",
      "name": "text",
      "description": "text",
      "metric_type": "numerical",
      "latency_tier": "batch",
      "period_granularity": "daily",
      "source": "call_intelligence",
      "custom_source_key": "text",
      "event_types": [
        "text"
      ],
      "source_filter": "text",
      "extraction_mode": "static",
      "extract_path": "text",
      "ai_labels": [
        "text"
      ],
      "ai_schema": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "ai_query_endpoint": "text",
      "ai_query_prompt": "text",
      "sql_expression": "text",
      "aggregation": "count",
      "ratio_numerator_event": "text",
      "ratio_denominator_event": "text",
      "valid_range_min": 1,
      "valid_range_max": 1,
      "freshness_sla_minutes": 60,
      "unit": "text",
      "categories": [
        "text"
      ],
      "model_tier": "free",
      "channel_scope": "all",
      "applies_to_product_types": [
        "text"
      ],
      "prompt": "text",
      "granularity": "aggregate",
      "active": true,
      "builtin": false
    }
  ]
}

Update metric definitions

put

Update the workspace metric definitions.

Partial updates supported — only provided fields are changed. The definitions list is replaced entirely when provided.

Permissions: admin, owner.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Body

application/json

Partial update — only provided fields are changed.

The definitions list is replaced entirely when provided. Built-in metrics can be deactivated (active=false) or have their freshness_sla_minutes changed, but their key cannot be reused for custom metrics.

Responses

200

Successful Response

application/json

404

Workspace not found

422

Validation error

429

Rate limited

put/v1/{workspace_id}/settings/metrics

HTTPcURLJavaScriptPython

PUT /v1/{workspace_id}/settings/metrics HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 827

{
  "definitions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "key": "text",
      "name": "text",
      "description": "text",
      "metric_type": "numerical",
      "latency_tier": "batch",
      "period_granularity": "daily",
      "source": "call_intelligence",
      "custom_source_key": "text",
      "event_types": [
        "text"
      ],
      "source_filter": "text",
      "extraction_mode": "static",
      "extract_path": "text",
      "ai_labels": [
        "text"
      ],
      "ai_schema": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "ai_query_endpoint": "text",
      "ai_query_prompt": "text",
      "sql_expression": "text",
      "aggregation": "count",
      "ratio_numerator_event": "text",
      "ratio_denominator_event": "text",
      "valid_range_min": 1,
      "valid_range_max": 1,
      "freshness_sla_minutes": 60,
      "unit": "text",
      "categories": [
        "text"
      ],
      "model_tier": "free",
      "channel_scope": "all",
      "applies_to_product_types": [
        "text"
      ],
      "prompt": "text",
      "granularity": "aggregate",
      "active": true,
      "builtin": false
    }
  ]
}

{
  "definitions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "key": "text",
      "name": "text",
      "description": "text",
      "metric_type": "numerical",
      "latency_tier": "batch",
      "period_granularity": "daily",
      "source": "call_intelligence",
      "custom_source_key": "text",
      "event_types": [
        "text"
      ],
      "source_filter": "text",
      "extraction_mode": "static",
      "extract_path": "text",
      "ai_labels": [
        "text"
      ],
      "ai_schema": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "ai_query_endpoint": "text",
      "ai_query_prompt": "text",
      "sql_expression": "text",
      "aggregation": "count",
      "ratio_numerator_event": "text",
      "ratio_denominator_event": "text",
      "valid_range_min": 1,
      "valid_range_max": 1,
      "freshness_sla_minutes": 60,
      "unit": "text",
      "categories": [
        "text"
      ],
      "model_tier": "free",
      "channel_scope": "all",
      "applies_to_product_types": [
        "text"
      ],
      "prompt": "text",
      "granularity": "aggregate",
      "active": true,
      "builtin": false
    }
  ]
}

Get outreach settings

get

Get the workspace outreach settings.

Returns empty rules and templates when not configured.

Permissions: authenticated (any role).

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Responses

200

Successful Response

application/json

429

Rate limited

get/v1/{workspace_id}/settings/outreach

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/settings/outreach HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "rules": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "trigger": "appointment_window",
      "trigger_config": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "channel": "email",
      "consent_required": true,
      "quiet_hours": {
        "enabled": false,
        "start_hour": 21,
        "end_hour": 8,
        "timezone": "America/New_York"
      },
      "review_required": false,
      "message_template": "Hi {first_name}, please complete your form: {surface_url}",
      "data_template_id": "123e4567-e89b-12d3-a456-426614174000",
      "form_template_id": "123e4567-e89b-12d3-a456-426614174000",
      "active": true
    }
  ],
  "data_templates": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "fields": [
        {
          "key": "text",
          "label": "text",
          "field_type": "text",
          "required": true,
          "sensitive": false,
          "path": "text"
        }
      ]
    }
  ]
}

Update outreach settings

put

Update the workspace outreach settings.

Partial updates supported — only provided fields are changed. Rules and data_templates lists are replaced entirely when provided.

Validates that data_template_id references in rules point to templates that exist in the same payload or current settings.

Permissions: admin, owner.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Body

application/json

Partial update — only provided fields are changed.

Rules and data_templates lists are replaced entirely when provided.

Responses

200

Successful Response

application/json

404

Workspace not found

422

Validation error

429

Rate limited

put/v1/{workspace_id}/settings/outreach

HTTPcURLJavaScriptPython

PUT /v1/{workspace_id}/settings/outreach HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 712

{
  "rules": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "trigger": "appointment_window",
      "trigger_config": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "channel": "email",
      "consent_required": true,
      "quiet_hours": {
        "enabled": false,
        "start_hour": 21,
        "end_hour": 8,
        "timezone": "America/New_York"
      },
      "review_required": false,
      "message_template": "Hi {first_name}, please complete your form: {surface_url}",
      "data_template_id": "123e4567-e89b-12d3-a456-426614174000",
      "form_template_id": "123e4567-e89b-12d3-a456-426614174000",
      "active": true
    }
  ],
  "data_templates": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "fields": [
        {
          "key": "text",
          "label": "text",
          "field_type": "text",
          "required": true,
          "sensitive": false,
          "path": "text"
        }
      ]
    }
  ]
}

{
  "rules": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "trigger": "appointment_window",
      "trigger_config": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "channel": "email",
      "consent_required": true,
      "quiet_hours": {
        "enabled": false,
        "start_hour": 21,
        "end_hour": 8,
        "timezone": "America/New_York"
      },
      "review_required": false,
      "message_template": "Hi {first_name}, please complete your form: {surface_url}",
      "data_template_id": "123e4567-e89b-12d3-a456-426614174000",
      "form_template_id": "123e4567-e89b-12d3-a456-426614174000",
      "active": true
    }
  ],
  "data_templates": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "fields": [
        {
          "key": "text",
          "label": "text",
          "field_type": "text",
          "required": true,
          "sensitive": false,
          "path": "text"
        }
      ]
    }
  ]
}

Get workspace branding

get

Get the workspace default branding for surfaces.

Returns empty branding when not configured.

Permissions: authenticated (any role).

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Responses

200

Successful Response

application/json

429

Rate limited

get/v1/{workspace_id}/settings/branding

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/settings/branding HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "branding": {
    "logo_url": "text",
    "primary_color": "text",
    "background_color": "text",
    "font_family": "text"
  }
}

Update workspace branding

put

Update the workspace default branding for surfaces.

Surface-level branding takes precedence over workspace-level branding.

Permissions: admin, owner.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Body

application/json

Update workspace branding. All fields are optional — only provided fields are changed.

Responses

200

Successful Response

application/json

404

Workspace not found

422

Validation error

429

Rate limited

put/v1/{workspace_id}/settings/branding

HTTPcURLJavaScriptPython

PUT /v1/{workspace_id}/settings/branding HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "branding": {
    "logo_url": "text",
    "primary_color": "text",
    "background_color": "text",
    "font_family": "text"
  }
}

{
  "branding": {
    "logo_url": "text",
    "primary_color": "text",
    "background_color": "text",
    "font_family": "text"
  }
}

Get environment overrides

get

Get per-environment config overrides.

Returns empty environments when not configured.

Permissions: authenticated (any role).

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Responses

200

Successful Response

application/json

429

Rate limited

get/v1/{workspace_id}/settings/environments

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/settings/environments HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "environments": {
    "ANY_ADDITIONAL_PROPERTY": {
      "data_source_id": "123e4567-e89b-12d3-a456-426614174000",
      "tool_overrides": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "data_source_overrides": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  }
}

Update environment overrides

put

Update per-environment config overrides.

Permissions: admin, owner.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Body

application/json

Responses

200

Successful Response

application/json

404

Workspace not found

422

Validation error

429

Rate limited

put/v1/{workspace_id}/settings/environments

HTTPcURLJavaScriptPython

PUT /v1/{workspace_id}/settings/environments HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 221

{
  "environments": {
    "ANY_ADDITIONAL_PROPERTY": {
      "data_source_id": "123e4567-e89b-12d3-a456-426614174000",
      "tool_overrides": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "data_source_overrides": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  }
}

{
  "environments": {
    "ANY_ADDITIONAL_PROPERTY": {
      "data_source_id": "123e4567-e89b-12d3-a456-426614174000",
      "tool_overrides": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "data_source_overrides": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  }
}

Get voice settings

get

Get the voice experience settings for a workspace.

Returns voice identity, domain vocabulary, and post-call intelligence configuration. These settings shape how the AI agent sounds and what domain-specific terms it recognizes accurately.

Permissions

• Requires authenticated API key (any role).

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Responses

200

Successful Response

application/json

Voice experience state — what the PM configured.

voice_idstring · nullableRequired

tonestring · nullableRequired

speednumber · nullableRequired

volumenumber · nullableRequired

languagestringRequired

keytermsstring[]Required

pronunciation_dict_idstring · nullableRequired

sensitive_topicsstring[]Required

post_call_analysis_enabledbooleanRequired

transcript_correction_enabledbooleanRequired

stt_providerstring · enum · nullableRequiredPossible values:

tts_providerstring · enum · nullableRequiredPossible values:

429

Rate limited

get/v1/{workspace_id}/settings/voice

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/settings/voice HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "voice_id": "text",
  "tone": "text",
  "speed": 1,
  "volume": 1,
  "language": "text",
  "keyterms": [
    "text"
  ],
  "pronunciation_dict_id": "text",
  "sensitive_topics": [
    "text"
  ],
  "post_call_analysis_enabled": true,
  "transcript_correction_enabled": true,
  "stt_provider": "deepgram",
  "tts_provider": "cartesia",
  "tts_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "language_providers": {
    "ANY_ADDITIONAL_PROPERTY": {
      "provider": "cartesia",
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  }
}

Update voice settings

put

Update the voice experience settings for a workspace.

Only provided fields are updated; omitted fields retain their current values. Set a field to null to reset it to default.

Voice Identity & Style

• voice_id: Voice identity UUID — determines the agent's voice persona
• tone: Emotional baseline (calm, sympathetic, enthusiastic, content, curious, cheerful, serious, friendly). The system also adapts tone dynamically based on real-time caller emotion analysis; this setting provides the baseline when no strong emotional signal is detected.
• speed: Speech rate multiplier (0.5-2.0)
• volume: Volume multiplier (0.0-1.0)
• language: BCP-47 language tag (default en)

Speech Recognition Boost

• keyterms: Exact words the speech recognition engine should prioritize. Use for specific names, drug names, and org jargon. Example: ["Dr. Ramirez", "metformin", "HIPAA"]

Post-Call Intelligence

• post_call_analysis_enabled: Run automated quality scoring after each call ends (default true)
• transcript_correction_enabled: Re-verify transcripts with a high-accuracy batch model after call ends (default true)

Permissions

• Requires admin or owner role.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Body

application/json

Voice experience control plane — PM-facing, high-level controls.

Controls the caller experience without exposing engineering internals. Emotion detection, filler speech, model selection, and buffer tuning are always-on internals managed by engineering.

voice_idstring · max: 128 · nullableOptional

tonestring · max: 2000 · nullableOptional

speednumber · nullableOptional

volumenumber · nullableOptional

languagestring · max: 32 · nullableOptional

keytermsstring[] · max: 200 · nullableOptional

pronunciation_dict_idstring · max: 128 · nullableOptional

sensitive_topicsstring[] · max: 50 · nullableOptional

post_call_analysis_enabledboolean · nullableOptional

transcript_correction_enabledboolean · nullableOptional

stt_providerstring · enum · nullableOptionalPossible values:

tts_providerstring · enum · nullableOptionalPossible values:

Responses

200

Successful Response

application/json

Voice experience state — what the PM configured.

voice_idstring · nullableRequired

tonestring · nullableRequired

speednumber · nullableRequired

volumenumber · nullableRequired

languagestringRequired

keytermsstring[]Required

pronunciation_dict_idstring · nullableRequired

sensitive_topicsstring[]Required

post_call_analysis_enabledbooleanRequired

transcript_correction_enabledbooleanRequired

stt_providerstring · enum · nullableRequiredPossible values:

tts_providerstring · enum · nullableRequiredPossible values:

404

Workspace not found

422

Validation error

429

Rate limited

put/v1/{workspace_id}/settings/voice

HTTPcURLJavaScriptPython

PUT /v1/{workspace_id}/settings/voice HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 447

{
  "voice_id": "text",
  "tone": "text",
  "speed": 1,
  "volume": 1,
  "language": "text",
  "keyterms": [
    "text"
  ],
  "pronunciation_dict_id": "text",
  "sensitive_topics": [
    "text"
  ],
  "post_call_analysis_enabled": true,
  "transcript_correction_enabled": true,
  "stt_provider": "deepgram",
  "tts_provider": "cartesia",
  "tts_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "language_providers": {
    "ANY_ADDITIONAL_PROPERTY": {
      "provider": "cartesia",
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  }
}

{
  "voice_id": "text",
  "tone": "text",
  "speed": 1,
  "volume": 1,
  "language": "text",
  "keyterms": [
    "text"
  ],
  "pronunciation_dict_id": "text",
  "sensitive_topics": [
    "text"
  ],
  "post_call_analysis_enabled": true,
  "transcript_correction_enabled": true,
  "stt_provider": "deepgram",
  "tts_provider": "cartesia",
  "tts_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "language_providers": {
    "ANY_ADDITIONAL_PROPERTY": {
      "provider": "cartesia",
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  }
}