AMamigo
Service

Get a service

Changed on

Read one service, including during maintenance. Requires Service:GetService.

get/v1/{organization}/service/{service_id}/

Request

Path parameters

service_idstring required

The exact identifier of the service.

organizationstring required

Headers

x-mongo-cluster-namestring nullable

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

Sec-WebSocket-Protocolstring[]

Response

Successful Response

idstring required

The identifier of the service.

namestring required

The name of the service.

version_setsobject required

The available version sets of the service.

descriptionstring required

A description of the service.

is_activeboolean required

Whether the service is active.

service_hierarchical_state_machine_idstring required

The ID of the state machine that this service uses.

agent_idstring required

The ID of the agent that this service uses.

keytermsstring[] required

A list of keyterms that are easy to get wrong during audio transcriptions that tend to occur commonly in audio sessions using this service.

updated_atstring date-time required

The timestamp to supply when deactivating this service.

Changes