Use Cases

Get the service binding for a use case

get

Return the platform service this use case is bound to in this workspace, or 404 if unbound. Requires Channel.view permission.

Authorizations

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

use_case_idstring · uuidRequired

Responses

200

Successful Response

application/json

use_case_idstring · uuidRequired

service_idstring · uuidRequired

workspace_idstring · uuidRequired

channelstring · enumRequiredPossible values:

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

403

Insufficient permissions.

404

Use case is not bound to a service in this workspace.

422

Validation Error

application/json

get/v1/{workspace_id}/use-cases/{use_case_id}/service-binding

GET /v1/{workspace_id}/use-cases/{use_case_id}/service-binding HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "use_case_id": "123e4567-e89b-12d3-a456-426614174000",
  "service_id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "channel": "inbound_voice",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Bind a use case to a platform service

put

Bind this use case to a platform service in the current workspace. PUT semantics — rebinding to a different service replaces the prior binding. Inbound webhook events for the use case will resolve to this workspace; outbound dispatch from the service will route through this use case for its channel. 409 if a different use case already binds the same (service, channel) pair. 404 if the service or use case is missing or the service belongs to another workspace. Requires Channel.create permission.

Authorizations

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

use_case_idstring · uuidRequired

Body

service_idstring · uuidRequired

Responses

200

Successful Response

application/json

use_case_idstring · uuidRequired

service_idstring · uuidRequired

workspace_idstring · uuidRequired

channelstring · enumRequiredPossible values:

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

403

Insufficient permissions.

404

Use case or service not found.

409

Service already has a different use case bound for this channel.

422

Unsupported use case channel.

502

Channel manager unavailable.

504

Channel manager timed out.

put/v1/{workspace_id}/use-cases/{use_case_id}/service-binding

PUT /v1/{workspace_id}/use-cases/{use_case_id}/service-binding HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "service_id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "use_case_id": "123e4567-e89b-12d3-a456-426614174000",
  "service_id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "channel": "inbound_voice",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Unbind a use case from its platform service

delete

Release a use case from its bound service in this workspace. Soft-delete on the binding row. 404 if the use case is not currently bound (covers both 'never bound' and 'already unbound'). Requires Channel.delete permission.

Authorizations

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

use_case_idstring · uuidRequired

Responses

204

Successful Response

No content

403

Insufficient permissions.

404

Use case is not bound to a service in this workspace.

422

Validation Error

application/json

delete/v1/{workspace_id}/use-cases/{use_case_id}/service-binding

DELETE /v1/{workspace_id}/use-cases/{use_case_id}/service-binding HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content