Workspaces

List workspaces

get

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/workspaces/

List workspaces accessible to this API key. Requires Workspace.view permission.

Authorizations

BearerAuth

AuthorizationstringRequired

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

Query parameters

limitinteger · max: 20OptionalDefault: 10

continuation_tokenintegerOptionalDefault: 0

Responses

200

Successful Response

application/json

has_morebooleanRequired

continuation_tokenany ofOptional

integerOptional

or

nullOptional

401

Missing or invalid API key.

403

Insufficient permissions.

422

Validation Error

application/json

get

/v1/workspaces/

HTTPcURLJavaScriptPython

GET /v1/workspaces/ HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "text",
      "slug": "text",
      "name": "text",
      "environment": "text",
      "backend_org_id": "text",
      "region": "text",
      "ehr_type": "text",
      "default_fhir_store_url": "text",
      "provisioned_at": "2026-03-22T05:27:55.867Z",
      "created_at": "2026-03-22T05:27:55.867Z",
      "updated_at": "2026-03-22T05:27:55.867Z"
    }
  ],
  "has_more": true,
  "continuation_token": 1
}

Create a workspace

post

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/workspaces/

Bootstrap a new workspace. No authentication required.

Authorizations

BearerAuth

AuthorizationstringRequired

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

Body

application/json

slugstring · min: 2 · max: 63RequiredPattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$

namestring · min: 1Required

environmentstring · enumRequiredPossible values:

regionstringOptionalDefault: us-east-1

backend_org_idany ofOptional

string · min: 1Optional

or

nullOptional

Responses

201

Successful Response

application/json

409

Workspace slug already taken.

422

Invalid request body.

post

/v1/workspaces/

HTTPcURLJavaScriptPython

POST /v1/workspaces/ HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "slug": "text",
  "name": "text",
  "environment": "production",
  "region": "us-east-1",
  "backend_org_id": "text"
}

{
  "id": "text",
  "slug": "text",
  "name": "text",
  "environment": "text",
  "backend_org_id": "text",
  "region": "text",
  "ehr_type": "text",
  "default_fhir_store_url": "text",
  "provisioned_at": "2026-03-22T05:27:55.867Z",
  "created_at": "2026-03-22T05:27:55.867Z",
  "updated_at": "2026-03-22T05:27:55.867Z"
}

Get a workspace

get

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/workspaces/{workspace_id}

Retrieve a workspace by ID. Requires Workspace.view permission.

Authorizations

BearerAuth

AuthorizationstringRequired

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

Responses

200

Successful Response

application/json

idstringRequired

slugstringRequired

namestringRequired

environmentstringRequired

backend_org_idany ofRequired

stringOptional

or

nullOptional

regionstringRequired

ehr_typeany ofRequired

stringOptional

or

nullOptional

default_fhir_store_urlany ofRequired

stringOptional

or

nullOptional

provisioned_atany ofRequired

string · date-timeOptional

or

nullOptional

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

401

Missing or invalid API key.

403

Insufficient permissions.

404

Workspace not found.

get

/v1/workspaces/{workspace_id}

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "slug": "text",
  "name": "text",
  "environment": "text",
  "backend_org_id": "text",
  "region": "text",
  "ehr_type": "text",
  "default_fhir_store_url": "text",
  "provisioned_at": "2026-03-22T05:27:55.867Z",
  "created_at": "2026-03-22T05:27:55.867Z",
  "updated_at": "2026-03-22T05:27:55.867Z"
}

Update a workspace

patch

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/workspaces/{workspace_id}

Update workspace fields. Requires Workspace.update permission.

Authorizations

BearerAuth

AuthorizationstringRequired

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

Body

application/json

nameany ofOptional

string · min: 1Optional

or

nullOptional

environmentany ofOptional

string · enumOptionalPossible values:

or

nullOptional

regionany ofOptional

stringOptional

or

nullOptional

ehr_typeany ofOptional

string · enumOptionalPossible values:

or

nullOptional

default_fhir_store_urlany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

idstringRequired

slugstringRequired

namestringRequired

environmentstringRequired

backend_org_idany ofRequired

stringOptional

or

nullOptional

regionstringRequired

ehr_typeany ofRequired

stringOptional

or

nullOptional

default_fhir_store_urlany ofRequired

stringOptional

or

nullOptional

provisioned_atany ofRequired

string · date-timeOptional

or

nullOptional

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

401

Missing or invalid API key.

403

Insufficient permissions.

404

Workspace not found.

422

Invalid request body.

patch

/v1/workspaces/{workspace_id}

HTTPcURLJavaScriptPython

PATCH /v1/workspaces/{workspace_id} HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 114

{
  "name": "text",
  "environment": "production",
  "region": "text",
  "ehr_type": "revolution",
  "default_fhir_store_url": "text"
}

{
  "id": "text",
  "slug": "text",
  "name": "text",
  "environment": "text",
  "backend_org_id": "text",
  "region": "text",
  "ehr_type": "text",
  "default_fhir_store_url": "text",
  "provisioned_at": "2026-03-22T05:27:55.867Z",
  "created_at": "2026-03-22T05:27:55.867Z",
  "updated_at": "2026-03-22T05:27:55.867Z"
}

Provision workspace resources

post

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/workspaces/{workspace_id}/provision

Seed default IntegrationConfig and mark workspace as provisioned. Idempotent. Requires Workspace.update permission.

Authorizations

BearerAuth

AuthorizationstringRequired

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

Responses

200

Successful Response

application/json

401

Missing or invalid API key.

403

Insufficient permissions.

404

Workspace not found.

post

/v1/workspaces/{workspace_id}/provision

HTTPcURLJavaScriptPython

POST /v1/workspaces/{workspace_id}/provision HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "workspace": {
    "id": "text",
    "slug": "text",
    "name": "text",
    "environment": "text",
    "backend_org_id": "text",
    "region": "text",
    "ehr_type": "text",
    "default_fhir_store_url": "text",
    "provisioned_at": "2026-03-22T05:27:55.867Z",
    "created_at": "2026-03-22T05:27:55.867Z",
    "updated_at": "2026-03-22T05:27:55.867Z"
  }
}

Get test caller numbers

get

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/workspaces/{workspace_id}/test-caller-numbers

Get phone numbers configured as test callers for this workspace.

Authorizations

BearerAuth

AuthorizationstringRequired

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

Responses

200

Successful Response

application/json

numbersstring[]Required

get

/v1/workspaces/{workspace_id}/test-caller-numbers

HTTPcURLJavaScriptPython

GET /v1/workspaces/{workspace_id}/test-caller-numbers HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful Response

{
  "numbers": [
    "text"
  ]
}

Update test caller numbers

put

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/workspaces/{workspace_id}/test-caller-numbers

Set phone numbers to be treated as test callers. Calls from these numbers will have direction='test' and be excluded from outbound EHR sync.

Authorizations

BearerAuth

AuthorizationstringRequired

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

Body

application/json

numbersstring[]Required

Responses

200

Successful Response

application/json

numbersstring[]Required

422

Validation Error

application/json

put

/v1/workspaces/{workspace_id}/test-caller-numbers

HTTPcURLJavaScriptPython

PUT /v1/workspaces/{workspace_id}/test-caller-numbers HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "numbers": [
    "text"
  ]
}

{
  "numbers": [
    "text"
  ]
}

Get voice settings

get

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/workspaces/{workspace_id}/voice-settings

Get voice pipeline settings (tone, speed, volume, filler, emotion detection, language) for this workspace.

Authorizations

BearerAuth

AuthorizationstringRequired

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

Responses

200

Successful Response

application/json

Voice experience state — what the PM configured.

voice_idany ofRequired

stringOptional

or

nullOptional

toneany ofRequired

stringOptional

or

nullOptional

speedany ofRequired

numberOptional

or

nullOptional

volumeany ofRequired

numberOptional

or

nullOptional

languagestringRequired

keytermsstring[]Required

correction_categoriesstring[]Required

pronunciation_dict_idany ofRequired

stringOptional

or

nullOptional

sensitive_topicsstring[]Required

post_call_analysis_enabledbooleanRequired

transcript_correction_enabledbooleanRequired

get

/v1/workspaces/{workspace_id}/voice-settings

HTTPcURLJavaScriptPython

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

200

Successful Response

{
  "voice_id": "text",
  "tone": "text",
  "speed": 1,
  "volume": 1,
  "language": "text",
  "keyterms": [
    "text"
  ],
  "correction_categories": [
    "text"
  ],
  "pronunciation_dict_id": "text",
  "sensitive_topics": [
    "text"
  ],
  "post_call_analysis_enabled": true,
  "transcript_correction_enabled": true
}

Update voice settings

put

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/workspaces/{workspace_id}/voice-settings

Update voice pipeline settings. Only provided fields are changed; omitted fields keep current values.

Authorizations

BearerAuth

AuthorizationstringRequired

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

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_idany ofOptional

stringOptional

or

nullOptional

toneany ofOptional

stringOptional

or

nullOptional

speedany ofOptional

numberOptional

or

nullOptional

volumeany ofOptional

numberOptional

or

nullOptional

languageany ofOptional

stringOptional

or

nullOptional

keytermsany ofOptional

string[]Optional

or

nullOptional

correction_categoriesany ofOptional

string[]Optional

or

nullOptional

pronunciation_dict_idany ofOptional

stringOptional

or

nullOptional

sensitive_topicsany ofOptional

string[]Optional

or

nullOptional

post_call_analysis_enabledany ofOptional

booleanOptional

or

nullOptional

transcript_correction_enabledany ofOptional

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

Voice experience state — what the PM configured.

voice_idany ofRequired

stringOptional

or

nullOptional

toneany ofRequired

stringOptional

or

nullOptional

speedany ofRequired

numberOptional

or

nullOptional

volumeany ofRequired

numberOptional

or

nullOptional

languagestringRequired

keytermsstring[]Required

correction_categoriesstring[]Required

pronunciation_dict_idany ofRequired

stringOptional

or

nullOptional

sensitive_topicsstring[]Required

post_call_analysis_enabledbooleanRequired

transcript_correction_enabledbooleanRequired

422

Validation Error

application/json

put

/v1/workspaces/{workspace_id}/voice-settings

HTTPcURLJavaScriptPython

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

{
  "voice_id": "text",
  "tone": "text",
  "speed": 1,
  "volume": 1,
  "language": "text",
  "keyterms": [
    "text"
  ],
  "correction_categories": [
    "text"
  ],
  "pronunciation_dict_id": "text",
  "sensitive_topics": [
    "text"
  ],
  "post_call_analysis_enabled": true,
  "transcript_correction_enabled": true
}

{
  "voice_id": "text",
  "tone": "text",
  "speed": 1,
  "volume": 1,
  "language": "text",
  "keyterms": [
    "text"
  ],
  "correction_categories": [
    "text"
  ],
  "pronunciation_dict_id": "text",
  "sensitive_topics": [
    "text"
  ],
  "post_call_analysis_enabled": true,
  "transcript_correction_enabled": true
}