Workspaces

Get a workspace

get

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.

Path parameters

workspace_idstring · uuidRequired

Responses

200

Successful Response

application/json

idstring · uuidRequired

slugstringRequired

namestringRequired

environmentstringRequired

backend_org_idstring · nullableRequired

regionstringRequired

connector_typestring · nullableRequired

provisioned_atstring · date-time · nullableRequired

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: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "slug": "text",
  "name": "text",
  "environment": "text",
  "backend_org_id": "text",
  "region": "text",
  "connector_type": "text",
  "provisioned_at": "2026-07-10T20:59:27.720Z",
  "created_at": "2026-07-10T20:59:27.720Z",
  "updated_at": "2026-07-10T20:59:27.720Z"
}

Update a workspace

patch

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.

Path parameters

workspace_idstring · uuidRequired

Body

application/json

namestring · min: 1 · nullableOptional

environmentstring · enum · nullableOptionalPossible values:

regionstring · enum · nullableOptionalPossible values:

connector_typestring · enum · nullableOptionalPossible values:

Responses

200

Successful Response

application/json

idstring · uuidRequired

slugstringRequired

namestringRequired

environmentstringRequired

backend_org_idstring · nullableRequired

regionstringRequired

connector_typestring · nullableRequired

provisioned_atstring · date-time · nullableRequired

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, or region provided (immutable).

patch/v1/workspaces/{workspace_id}

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "environment": "production",
  "region": "us-east-1",
  "connector_type": "epic"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "slug": "text",
  "name": "text",
  "environment": "text",
  "backend_org_id": "text",
  "region": "text",
  "connector_type": "text",
  "provisioned_at": "2026-07-10T20:59:27.720Z",
  "created_at": "2026-07-10T20:59:27.720Z",
  "updated_at": "2026-07-10T20:59:27.720Z"
}

List workspaces

get

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: 100OptionalDefault: 10

continuation_tokenintegerOptionalDefault: 0

Responses

200

Successful Response

application/json

has_morebooleanRequired

continuation_tokeninteger · nullableOptional

totalinteger · nullableOptional

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: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "slug": "text",
      "name": "text",
      "environment": "text",
      "backend_org_id": "text",
      "region": "text",
      "connector_type": "text",
      "provisioned_at": "2026-07-10T20:59:27.720Z",
      "created_at": "2026-07-10T20:59:27.720Z",
      "updated_at": "2026-07-10T20:59:27.720Z"
    }
  ],
  "has_more": true,
  "continuation_token": 1,
  "total": 1
}

Provision workspace resources

post

Seed default integrations 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.

Path parameters

workspace_idstring · uuidRequired

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: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "workspace": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "slug": "text",
    "name": "text",
    "environment": "text",
    "backend_org_id": "text",
    "region": "text",
    "connector_type": "text",
    "provisioned_at": "2026-07-10T20:59:27.720Z",
    "created_at": "2026-07-10T20:59:27.720Z",
    "updated_at": "2026-07-10T20:59:27.720Z"
  }
}

Archive a workspace

post

Archive a workspace and remove it from active access flows while preserving underlying data. Requires owner access and slug confirmation.

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

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

Responses

200

Successful Response

application/json

idstring · uuidRequired

slugstringRequired

namestringRequired

environmentstringRequired

backend_org_idstring · nullableRequired

regionstringRequired

connector_typestring · nullableRequired

provisioned_atstring · date-time · nullableRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

401

Missing or invalid API key.

403

Only owners can archive a workspace.

404

Workspace not found.

422

Workspace slug confirmation did not match.

post/v1/workspaces/{workspace_id}/archive

HTTPcURLJavaScriptPython

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

{
  "slug": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "slug": "text",
  "name": "text",
  "environment": "text",
  "backend_org_id": "text",
  "region": "text",
  "connector_type": "text",
  "provisioned_at": "2026-07-10T20:59:27.720Z",
  "created_at": "2026-07-10T20:59:27.720Z",
  "updated_at": "2026-07-10T20:59:27.720Z"
}

Pre-check environment conversion

get

Returns compliance warnings for converting between staging and production. Does not mutate.

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

Query parameters

targetstring · enumOptionalDefault: productionPossible values:

Responses

200

Successful Response

application/json

currentstringRequired

targetstringRequired

warningsstring[]Required

401

Missing or invalid API key.

403

Insufficient permissions.

422

Validation Error

application/json

get/v1/workspaces/{workspace_id}/environment-check

HTTPcURLJavaScriptPython

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

{
  "current": "text",
  "target": "text",
  "warnings": [
    "text"
  ]
}

Convert workspace environment

post

Convert workspace between staging and production. Requires slug confirmation.

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

targetstring · enumRequiredPossible values:

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

Responses

200

Successful Response

application/json

idstring · uuidRequired

slugstringRequired

namestringRequired

environmentstringRequired

backend_org_idstring · nullableRequired

regionstringRequired

connector_typestring · nullableRequired

provisioned_atstring · date-time · nullableRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

401

Missing or invalid API key.

403

Insufficient permissions.

404

Workspace not found.

422

Workspace slug confirmation did not match.

post/v1/workspaces/{workspace_id}/convert-environment

HTTPcURLJavaScriptPython

POST /v1/workspaces/{workspace_id}/convert-environment HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "target": "production",
  "confirm_slug": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "slug": "text",
  "name": "text",
  "environment": "text",
  "backend_org_id": "text",
  "region": "text",
  "connector_type": "text",
  "provisioned_at": "2026-07-10T20:59:27.720Z",
  "created_at": "2026-07-10T20:59:27.720Z",
  "updated_at": "2026-07-10T20:59:27.720Z"
}

Get test caller numbers

get

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.

Path parameters

workspace_idstring · uuidRequired

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: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful Response

{
  "numbers": [
    "text"
  ]
}

Update test caller numbers

put

Set phone numbers to be treated as test callers. Calls from these numbers are tagged source='test' and excluded from billing, scores, analytics, outbound EHR sync, and entity views.

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

numbersstring[] · max: 100Required

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: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "numbers": [
    "text"
  ]
}

{
  "numbers": [
    "text"
  ]
}

Get test credential IDs

get

Get the credential IDs configured as test principals for this workspace's text channel.

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

credential_idsstring · uuid[]Required

get/v1/workspaces/{workspace_id}/test-credential-ids

HTTPcURLJavaScriptPython

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

200

Successful Response

{
  "credential_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Update test credential IDs

put

Set credential IDs to be treated as test principals. Text turns from these credentials are tagged source='test' and excluded from billing, scores, analytics, outbound EHR sync, and entity views.

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

credential_idsstring · uuid[] · max: 100Required

Responses

200

Successful Response

application/json

credential_idsstring · uuid[]Required

422

Validation Error

application/json

put/v1/workspaces/{workspace_id}/test-credential-ids

HTTPcURLJavaScriptPython

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

{
  "credential_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

{
  "credential_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}