Services

List services

get

List services in a workspace with pagination. Requires Service.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

Query parameters

searchstring · min: 1 · max: 200 · nullableOptional

sort_bystring · nullableOptional

is_activeboolean · nullableOptional

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.

404

Not found.

422

Validation Error

application/json

get/v1/{workspace_id}/services

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

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "agent_id": "123e4567-e89b-12d3-a456-426614174000",
      "context_graph_id": "123e4567-e89b-12d3-a456-426614174000",
      "agent_name": "text",
      "context_graph_name": "text",
      "keyterms": [
        "text"
      ],
      "is_active": true,
      "version_sets": {
        "ANY_ADDITIONAL_PROPERTY": {
          "agent_version_number": 1,
          "context_graph_version_number": 1,
          "llm_model_preferences": {
            "ANY_ADDITIONAL_PROPERTY": {
              "llm_name": "text",
              "params": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "experience_controls": {
                "verbosity": "low",
                "reasoning_effort": "none",
                "temperature": 1,
                "top_p": 1,
                "presence_penalty": 1,
                "frequency_penalty": 1,
                "response_format": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                },
                "seed": 1,
                "stop": "text",
                "logit_bias": {
                  "ANY_ADDITIONAL_PROPERTY": 1
                },
                "logprobs": true,
                "top_logprobs": 1,
                "parallel_tool_calls": true,
                "service_tier": "text",
                "prompt_cache_key": "text",
                "prompt_cache_retention": "in-memory",
                "safety_identifier": "text",
                "store": true,
                "metadata": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                }
              }
            }
          },
          "turn_runtime": "native"
        }
      },
      "tags": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "tool_capacity": 1,
      "channel_type": "voice",
      "environment": "production",
      "voice_config": {
        "tts_model": "sonic-turbo",
        "max_buffer_delay_ms": 1,
        "eager_eot_threshold": 1,
        "eot_timeout_ms": 1,
        "filler_style": "backchannel",
        "filler_vocabulary": [
          "text"
        ],
        "backchannel_delay_ms": 400,
        "max_response_sentences": 1,
        "max_response_words": 1,
        "barge_in_min_speech_s": 1,
        "barge_in_cooldown_s": 1,
        "min_tts_speed": 1,
        "post_eot_pause_ms": 1,
        "transition_deadline_ms": 1,
        "progress_interval_ms": 1,
        "empathy_hold_ms": 1,
        "filler_cooldown_ms": 1,
        "progress_vocabulary": [
          "text"
        ],
        "tts_provider": "cartesia",
        "tts_config": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "language_providers": {
          "ANY_ADDITIONAL_PROPERTY": {
            "provider": "cartesia",
            "config": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          }
        },
        "session_provider": "amigo",
        "forward_call_enabled": false,
        "forwarding": {
          "forward_to": "text",
          "should_disconnect": true,
          "warm_transfer": true
        }
      },
      "is_system": false,
      "created_at": "2026-07-10T21:49:11.459Z",
      "updated_at": "2026-07-10T21:49:11.459Z"
    }
  ],
  "has_more": true,
  "continuation_token": 1,
  "total": 1
}

Create a service

post

Create a new service linking an agent and HSM. Validates that agent_id and context_graph_id exist in the workspace. Requires Service.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

Body

namestring · min: 1 · max: 256Required

descriptionstring · max: 2000OptionalDefault: ""

agent_idstring · uuidRequired

context_graph_idstring · uuidRequired

keytermsstring[] · max: 500Optional

is_activebooleanOptionalDefault: true

tool_capacityinteger · min: 1 · max: 10OptionalDefault: 3

channel_typestring · enumOptionalDefault: voicePossible values:

environmentstring · enumOptionalDefault: productionPossible values:

Responses

201

Successful Response

application/json

idstring · uuidRequired

workspace_idstring · uuidRequired

namestringRequired

descriptionstringRequired

agent_idstring · uuidRequired

context_graph_idstring · uuidRequired

agent_namestring · nullableOptional

context_graph_namestring · nullableOptional

keytermsstring[]Required

is_activebooleanRequired

tool_capacityintegerRequired

channel_typestring · enumOptionalDefault: voicePossible values:

environmentstring · enumOptionalDefault: productionPossible values:

is_systembooleanOptionalDefault: false

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

401

Missing or invalid API key.

403

Insufficient permissions.

404

Not found.

409

Name already taken.

422

Invalid request body.

post/v1/{workspace_id}/services

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

{
  "name": "text",
  "description": "",
  "agent_id": "123e4567-e89b-12d3-a456-426614174000",
  "context_graph_id": "123e4567-e89b-12d3-a456-426614174000",
  "keyterms": [
    "text"
  ],
  "is_active": true,
  "version_sets": {
    "ANY_ADDITIONAL_PROPERTY": {
      "agent_version_number": 1,
      "context_graph_version_number": 1,
      "llm_model_preferences": {
        "ANY_ADDITIONAL_PROPERTY": {
          "llm_name": "text",
          "params": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "experience_controls": {
            "verbosity": "low",
            "reasoning_effort": "none",
            "temperature": 1,
            "top_p": 1,
            "presence_penalty": 1,
            "frequency_penalty": 1,
            "response_format": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "seed": 1,
            "stop": "text",
            "logit_bias": {
              "ANY_ADDITIONAL_PROPERTY": 1
            },
            "logprobs": true,
            "top_logprobs": 1,
            "parallel_tool_calls": true,
            "service_tier": "text",
            "prompt_cache_key": "text",
            "prompt_cache_retention": "in-memory",
            "safety_identifier": "text",
            "store": true,
            "metadata": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            }
          }
        }
      },
      "turn_runtime": "native"
    }
  },
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "tool_capacity": 3,
  "channel_type": "voice",
  "environment": "production",
  "voice_config": {
    "tts_model": "sonic-turbo",
    "max_buffer_delay_ms": 1,
    "eager_eot_threshold": 1,
    "eot_timeout_ms": 1,
    "filler_style": "backchannel",
    "filler_vocabulary": [
      "text"
    ],
    "backchannel_delay_ms": 400,
    "max_response_sentences": 1,
    "max_response_words": 1,
    "barge_in_min_speech_s": 1,
    "barge_in_cooldown_s": 1,
    "min_tts_speed": 1,
    "post_eot_pause_ms": 1,
    "transition_deadline_ms": 1,
    "progress_interval_ms": 1,
    "empathy_hold_ms": 1,
    "filler_cooldown_ms": 1,
    "progress_vocabulary": [
      "text"
    ],
    "tts_provider": "cartesia",
    "tts_config": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "language_providers": {
      "ANY_ADDITIONAL_PROPERTY": {
        "provider": "cartesia",
        "config": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    },
    "session_provider": "amigo",
    "forward_call_enabled": false,
    "forwarding": {
      "forward_to": "text",
      "should_disconnect": true,
      "warm_transfer": true
    }
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "agent_id": "123e4567-e89b-12d3-a456-426614174000",
  "context_graph_id": "123e4567-e89b-12d3-a456-426614174000",
  "agent_name": "text",
  "context_graph_name": "text",
  "keyterms": [
    "text"
  ],
  "is_active": true,
  "version_sets": {
    "ANY_ADDITIONAL_PROPERTY": {
      "agent_version_number": 1,
      "context_graph_version_number": 1,
      "llm_model_preferences": {
        "ANY_ADDITIONAL_PROPERTY": {
          "llm_name": "text",
          "params": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "experience_controls": {
            "verbosity": "low",
            "reasoning_effort": "none",
            "temperature": 1,
            "top_p": 1,
            "presence_penalty": 1,
            "frequency_penalty": 1,
            "response_format": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "seed": 1,
            "stop": "text",
            "logit_bias": {
              "ANY_ADDITIONAL_PROPERTY": 1
            },
            "logprobs": true,
            "top_logprobs": 1,
            "parallel_tool_calls": true,
            "service_tier": "text",
            "prompt_cache_key": "text",
            "prompt_cache_retention": "in-memory",
            "safety_identifier": "text",
            "store": true,
            "metadata": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            }
          }
        }
      },
      "turn_runtime": "native"
    }
  },
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "tool_capacity": 1,
  "channel_type": "voice",
  "environment": "production",
  "voice_config": {
    "tts_model": "sonic-turbo",
    "max_buffer_delay_ms": 1,
    "eager_eot_threshold": 1,
    "eot_timeout_ms": 1,
    "filler_style": "backchannel",
    "filler_vocabulary": [
      "text"
    ],
    "backchannel_delay_ms": 400,
    "max_response_sentences": 1,
    "max_response_words": 1,
    "barge_in_min_speech_s": 1,
    "barge_in_cooldown_s": 1,
    "min_tts_speed": 1,
    "post_eot_pause_ms": 1,
    "transition_deadline_ms": 1,
    "progress_interval_ms": 1,
    "empathy_hold_ms": 1,
    "filler_cooldown_ms": 1,
    "progress_vocabulary": [
      "text"
    ],
    "tts_provider": "cartesia",
    "tts_config": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "language_providers": {
      "ANY_ADDITIONAL_PROPERTY": {
        "provider": "cartesia",
        "config": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    },
    "session_provider": "amigo",
    "forward_call_enabled": false,
    "forwarding": {
      "forward_to": "text",
      "should_disconnect": true,
      "warm_transfer": true
    }
  },
  "is_system": false,
  "created_at": "2026-07-10T21:49:11.459Z",
  "updated_at": "2026-07-10T21:49:11.459Z"
}

Get a service

get

Retrieve a service by ID. Requires Service.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

service_idstring · uuidRequired

Responses

200

Successful Response

application/json

idstring · uuidRequired

workspace_idstring · uuidRequired

namestringRequired

descriptionstringRequired

agent_idstring · uuidRequired

context_graph_idstring · uuidRequired

agent_namestring · nullableOptional

context_graph_namestring · nullableOptional

keytermsstring[]Required

is_activebooleanRequired

tool_capacityintegerRequired

channel_typestring · enumOptionalDefault: voicePossible values:

environmentstring · enumOptionalDefault: productionPossible values:

is_systembooleanOptionalDefault: false

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

401

Missing or invalid API key.

403

Insufficient permissions.

404

Not found.

422

Validation Error

application/json

get/v1/{workspace_id}/services/{service_id}

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "agent_id": "123e4567-e89b-12d3-a456-426614174000",
  "context_graph_id": "123e4567-e89b-12d3-a456-426614174000",
  "agent_name": "text",
  "context_graph_name": "text",
  "keyterms": [
    "text"
  ],
  "is_active": true,
  "version_sets": {
    "ANY_ADDITIONAL_PROPERTY": {
      "agent_version_number": 1,
      "context_graph_version_number": 1,
      "llm_model_preferences": {
        "ANY_ADDITIONAL_PROPERTY": {
          "llm_name": "text",
          "params": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "experience_controls": {
            "verbosity": "low",
            "reasoning_effort": "none",
            "temperature": 1,
            "top_p": 1,
            "presence_penalty": 1,
            "frequency_penalty": 1,
            "response_format": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "seed": 1,
            "stop": "text",
            "logit_bias": {
              "ANY_ADDITIONAL_PROPERTY": 1
            },
            "logprobs": true,
            "top_logprobs": 1,
            "parallel_tool_calls": true,
            "service_tier": "text",
            "prompt_cache_key": "text",
            "prompt_cache_retention": "in-memory",
            "safety_identifier": "text",
            "store": true,
            "metadata": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            }
          }
        }
      },
      "turn_runtime": "native"
    }
  },
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "tool_capacity": 1,
  "channel_type": "voice",
  "environment": "production",
  "voice_config": {
    "tts_model": "sonic-turbo",
    "max_buffer_delay_ms": 1,
    "eager_eot_threshold": 1,
    "eot_timeout_ms": 1,
    "filler_style": "backchannel",
    "filler_vocabulary": [
      "text"
    ],
    "backchannel_delay_ms": 400,
    "max_response_sentences": 1,
    "max_response_words": 1,
    "barge_in_min_speech_s": 1,
    "barge_in_cooldown_s": 1,
    "min_tts_speed": 1,
    "post_eot_pause_ms": 1,
    "transition_deadline_ms": 1,
    "progress_interval_ms": 1,
    "empathy_hold_ms": 1,
    "filler_cooldown_ms": 1,
    "progress_vocabulary": [
      "text"
    ],
    "tts_provider": "cartesia",
    "tts_config": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "language_providers": {
      "ANY_ADDITIONAL_PROPERTY": {
        "provider": "cartesia",
        "config": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    },
    "session_provider": "amigo",
    "forward_call_enabled": false,
    "forwarding": {
      "forward_to": "text",
      "should_disconnect": true,
      "warm_transfer": true
    }
  },
  "is_system": false,
  "created_at": "2026-07-10T21:49:11.459Z",
  "updated_at": "2026-07-10T21:49:11.459Z"
}

Update a service

put

Update a service's configuration. Requires Service.update 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

service_idstring · uuidRequired

Body

namestring · min: 1 · max: 256 · nullableOptional

descriptionstring · max: 2000 · nullableOptional

agent_idstring · uuid · nullableOptional

context_graph_idstring · uuid · nullableOptional

keytermsstring[] · max: 500 · nullableOptional

is_activeboolean · nullableOptional

tool_capacityinteger · min: 1 · max: 10 · nullableOptional

channel_typestring · enum · nullableOptionalPossible values:

environmentstring · enum · nullableOptionalPossible values:

Responses

200

Successful Response

application/json

idstring · uuidRequired

workspace_idstring · uuidRequired

namestringRequired

descriptionstringRequired

agent_idstring · uuidRequired

context_graph_idstring · uuidRequired

agent_namestring · nullableOptional

context_graph_namestring · nullableOptional

keytermsstring[]Required

is_activebooleanRequired

tool_capacityintegerRequired

channel_typestring · enumOptionalDefault: voicePossible values:

environmentstring · enumOptionalDefault: productionPossible values:

is_systembooleanOptionalDefault: false

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

401

Missing or invalid API key.

403

Insufficient permissions.

404

Not found.

409

Name already taken.

422

Invalid request body.

put/v1/{workspace_id}/services/{service_id}

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

{
  "name": "text",
  "description": "text",
  "agent_id": "123e4567-e89b-12d3-a456-426614174000",
  "context_graph_id": "123e4567-e89b-12d3-a456-426614174000",
  "keyterms": [
    "text"
  ],
  "is_active": true,
  "version_sets": {
    "ANY_ADDITIONAL_PROPERTY": {
      "agent_version_number": 1,
      "context_graph_version_number": 1,
      "llm_model_preferences": {
        "ANY_ADDITIONAL_PROPERTY": {
          "llm_name": "text",
          "params": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "experience_controls": {
            "verbosity": "low",
            "reasoning_effort": "none",
            "temperature": 1,
            "top_p": 1,
            "presence_penalty": 1,
            "frequency_penalty": 1,
            "response_format": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "seed": 1,
            "stop": "text",
            "logit_bias": {
              "ANY_ADDITIONAL_PROPERTY": 1
            },
            "logprobs": true,
            "top_logprobs": 1,
            "parallel_tool_calls": true,
            "service_tier": "text",
            "prompt_cache_key": "text",
            "prompt_cache_retention": "in-memory",
            "safety_identifier": "text",
            "store": true,
            "metadata": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            }
          }
        }
      },
      "turn_runtime": "native"
    }
  },
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "tool_capacity": 1,
  "channel_type": "voice",
  "environment": "sandbox",
  "voice_config": {
    "tts_model": "sonic-turbo",
    "max_buffer_delay_ms": 1,
    "eager_eot_threshold": 1,
    "eot_timeout_ms": 1,
    "filler_style": "backchannel",
    "filler_vocabulary": [
      "text"
    ],
    "backchannel_delay_ms": 400,
    "max_response_sentences": 1,
    "max_response_words": 1,
    "barge_in_min_speech_s": 1,
    "barge_in_cooldown_s": 1,
    "min_tts_speed": 1,
    "post_eot_pause_ms": 1,
    "transition_deadline_ms": 1,
    "progress_interval_ms": 1,
    "empathy_hold_ms": 1,
    "filler_cooldown_ms": 1,
    "progress_vocabulary": [
      "text"
    ],
    "tts_provider": "cartesia",
    "tts_config": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "language_providers": {
      "ANY_ADDITIONAL_PROPERTY": {
        "provider": "cartesia",
        "config": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    },
    "session_provider": "amigo",
    "forward_call_enabled": false,
    "forwarding": {
      "forward_to": "text",
      "should_disconnect": true,
      "warm_transfer": true
    }
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "agent_id": "123e4567-e89b-12d3-a456-426614174000",
  "context_graph_id": "123e4567-e89b-12d3-a456-426614174000",
  "agent_name": "text",
  "context_graph_name": "text",
  "keyterms": [
    "text"
  ],
  "is_active": true,
  "version_sets": {
    "ANY_ADDITIONAL_PROPERTY": {
      "agent_version_number": 1,
      "context_graph_version_number": 1,
      "llm_model_preferences": {
        "ANY_ADDITIONAL_PROPERTY": {
          "llm_name": "text",
          "params": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "experience_controls": {
            "verbosity": "low",
            "reasoning_effort": "none",
            "temperature": 1,
            "top_p": 1,
            "presence_penalty": 1,
            "frequency_penalty": 1,
            "response_format": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "seed": 1,
            "stop": "text",
            "logit_bias": {
              "ANY_ADDITIONAL_PROPERTY": 1
            },
            "logprobs": true,
            "top_logprobs": 1,
            "parallel_tool_calls": true,
            "service_tier": "text",
            "prompt_cache_key": "text",
            "prompt_cache_retention": "in-memory",
            "safety_identifier": "text",
            "store": true,
            "metadata": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            }
          }
        }
      },
      "turn_runtime": "native"
    }
  },
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "tool_capacity": 1,
  "channel_type": "voice",
  "environment": "production",
  "voice_config": {
    "tts_model": "sonic-turbo",
    "max_buffer_delay_ms": 1,
    "eager_eot_threshold": 1,
    "eot_timeout_ms": 1,
    "filler_style": "backchannel",
    "filler_vocabulary": [
      "text"
    ],
    "backchannel_delay_ms": 400,
    "max_response_sentences": 1,
    "max_response_words": 1,
    "barge_in_min_speech_s": 1,
    "barge_in_cooldown_s": 1,
    "min_tts_speed": 1,
    "post_eot_pause_ms": 1,
    "transition_deadline_ms": 1,
    "progress_interval_ms": 1,
    "empathy_hold_ms": 1,
    "filler_cooldown_ms": 1,
    "progress_vocabulary": [
      "text"
    ],
    "tts_provider": "cartesia",
    "tts_config": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "language_providers": {
      "ANY_ADDITIONAL_PROPERTY": {
        "provider": "cartesia",
        "config": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    },
    "session_provider": "amigo",
    "forward_call_enabled": false,
    "forwarding": {
      "forward_to": "text",
      "should_disconnect": true,
      "warm_transfer": true
    }
  },
  "is_system": false,
  "created_at": "2026-07-10T21:49:11.459Z",
  "updated_at": "2026-07-10T21:49:11.459Z"
}

Delete a service

delete

Delete a service. Requires Service.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

service_idstring · uuidRequired

Responses

204

Successful Response

No content

401

Missing or invalid API key.

403

Insufficient permissions.

404

Not found.

422

Validation Error

application/json

delete/v1/{workspace_id}/services/{service_id}

DELETE /v1/{workspace_id}/services/{service_id} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Upsert a service version set

put

Replace or create a named version set on a service. Pinned agent/HSM versions are validated.

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

service_idstring · uuidRequired

namestring · max: 40Required

Version set name (e.g. 'release')

Body

Responses

204

Successful Response

No content

401

Missing or invalid API key.

403

Insufficient permissions.

404

Not found.

409

Name already taken.

422

Invalid request body.

put/v1/{workspace_id}/services/{service_id}/version-sets/{name}

PUT /v1/{workspace_id}/services/{service_id}/version-sets/{name} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 710

{
  "version_set": {
    "agent_version_number": 1,
    "context_graph_version_number": 1,
    "llm_model_preferences": {
      "ANY_ADDITIONAL_PROPERTY": {
        "llm_name": "text",
        "params": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "experience_controls": {
          "verbosity": "low",
          "reasoning_effort": "none",
          "temperature": 1,
          "top_p": 1,
          "presence_penalty": 1,
          "frequency_penalty": 1,
          "response_format": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "seed": 1,
          "stop": "text",
          "logit_bias": {
            "ANY_ADDITIONAL_PROPERTY": 1
          },
          "logprobs": true,
          "top_logprobs": 1,
          "parallel_tool_calls": true,
          "service_tier": "text",
          "prompt_cache_key": "text",
          "prompt_cache_retention": "in-memory",
          "safety_identifier": "text",
          "store": true,
          "metadata": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      }
    },
    "turn_runtime": "native"
  }
}

No content

Voice Turn

post

Run one WhatsApp-style voice-note turn against the service's agent.

Accepts OGG Opus audio (or any format Deepgram's prerecorded endpoint accepts). Server keys the conversation on (workspace, service, phone_number) and returns the agent's spoken reply as OGG Opus.

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

service_idstring · uuidRequired

Body

audiostringRequired

phone_numberstring · max: 16RequiredPattern: ^\+[1-9]\d{1,14}$

Responses

200

OGG Opus agent reply

anyOptional

204

Agent elected silence

409

Concurrent voice turn in progress for this speaker

422

Validation Error

application/json

post/v1/{workspace_id}/services/{service_id}/voice-turn

POST /v1/{workspace_id}/services/{service_id}/voice-turn HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 38

{
  "audio": "text",
  "phone_number": "text"
}

No content

Text Turn

post

Run one WhatsApp-style text turn against the service's agent.

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

service_idstring · uuidRequired

Body

Request body for POST /v1/{ws}/services/{service_id}/text-turn.

phone_numberstring · max: 16RequiredPattern: ^\+[1-9]\d{1,14}$

agent_phonestring · max: 16RequiredPattern: ^\+[1-9]\d{1,14}$

textstring · min: 1 · max: 8192Required

Responses

200

Agent text reply

application/json

Response body — the agent's text reply.

Returned only on 200; 204 indicates the engine elected silence.

textstring · max: 8192Required

204

Agent elected silence

409

Concurrent text turn in progress for this speaker

422

Validation Error

application/json

post/v1/{workspace_id}/services/{service_id}/text-turn

POST /v1/{workspace_id}/services/{service_id}/text-turn HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "phone_number": "text",
  "agent_phone": "text",
  "text": "text"
}

{
  "text": "text"
}

PreviousContext Graphs NextVoice Judge

Last updated 56 minutes ago

Was this helpful?