Services

List services

get

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

/v1/{workspace_id}/services/

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

sort_byany ofOptional

stringOptional

or

nullOptional

is_activeany ofOptional

booleanOptional

or

nullOptional

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.

404

Not found.

422

Validation Error

application/json

get

/v1/{workspace_id}/services/

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "id": "text",
      "workspace_id": "text",
      "name": "text",
      "description": "text",
      "agent_id": "text",
      "hsm_id": "text",
      "agent_name": "text",
      "hsm_name": "text",
      "keyterms": [
        "text"
      ],
      "is_active": true,
      "version_sets": {
        "ANY_ADDITIONAL_PROPERTY": {
          "agent_version_number": 1,
          "service_hierarchical_state_machine_version_number": 1,
          "llm_model_preferences": {
            "ANY_ADDITIONAL_PROPERTY": {
              "llm_name": "text",
              "params": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              }
            }
          }
        }
      },
      "tags": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "tool_capacity": 1,
      "created_at": "2026-03-22T05:27:57.008Z",
      "updated_at": "2026-03-22T05:27:57.008Z"
    }
  ],
  "has_more": true,
  "continuation_token": 1
}

Create a service

post

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

/v1/{workspace_id}/services/

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

namestring · min: 1Required

descriptionstringOptionalDefault: ""

agent_idstring · uuidRequired

hsm_idstring · uuidRequired

keytermsstring[]OptionalDefault: []

is_activebooleanOptionalDefault: true

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

Responses

201

Successful Response

application/json

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/

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "description": "",
  "agent_id": "123e4567-e89b-12d3-a456-426614174000",
  "hsm_id": "123e4567-e89b-12d3-a456-426614174000",
  "keyterms": [
    "text"
  ],
  "is_active": true,
  "version_sets": {
    "ANY_ADDITIONAL_PROPERTY": {
      "agent_version_number": 1,
      "service_hierarchical_state_machine_version_number": 1,
      "llm_model_preferences": {
        "ANY_ADDITIONAL_PROPERTY": {
          "llm_name": "text",
          "params": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        }
      }
    }
  },
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "tool_capacity": 3
}

{
  "id": "text",
  "workspace_id": "text",
  "name": "text",
  "description": "text",
  "agent_id": "text",
  "hsm_id": "text",
  "agent_name": "text",
  "hsm_name": "text",
  "keyterms": [
    "text"
  ],
  "is_active": true,
  "version_sets": {
    "ANY_ADDITIONAL_PROPERTY": {
      "agent_version_number": 1,
      "service_hierarchical_state_machine_version_number": 1,
      "llm_model_preferences": {
        "ANY_ADDITIONAL_PROPERTY": {
          "llm_name": "text",
          "params": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        }
      }
    }
  },
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "tool_capacity": 1,
  "created_at": "2026-03-22T05:27:57.008Z",
  "updated_at": "2026-03-22T05:27:57.008Z"
}

Get a service

get

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

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

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

service_idstring · uuidRequired

Responses

200

Successful Response

application/json

idstringRequired

workspace_idstringRequired

namestringRequired

descriptionstringRequired

agent_idstringRequired

hsm_idstringRequired

agent_nameany ofOptional

stringOptional

or

nullOptional

hsm_nameany ofOptional

stringOptional

or

nullOptional

keytermsstring[]Required

is_activebooleanRequired

tool_capacityintegerRequired

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}

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "workspace_id": "text",
  "name": "text",
  "description": "text",
  "agent_id": "text",
  "hsm_id": "text",
  "agent_name": "text",
  "hsm_name": "text",
  "keyterms": [
    "text"
  ],
  "is_active": true,
  "version_sets": {
    "ANY_ADDITIONAL_PROPERTY": {
      "agent_version_number": 1,
      "service_hierarchical_state_machine_version_number": 1,
      "llm_model_preferences": {
        "ANY_ADDITIONAL_PROPERTY": {
          "llm_name": "text",
          "params": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        }
      }
    }
  },
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "tool_capacity": 1,
  "created_at": "2026-03-22T05:27:57.008Z",
  "updated_at": "2026-03-22T05:27:57.008Z"
}

Update a service

put

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

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

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

service_idstring · uuidRequired

Body

application/json

nameany ofOptional

string · min: 1Optional

or

nullOptional

descriptionany ofOptional

stringOptional

or

nullOptional

agent_idany ofOptional

string · uuidOptional

or

nullOptional

hsm_idany ofOptional

string · uuidOptional

or

nullOptional

keytermsany ofOptional

string[]Optional

or

nullOptional

is_activeany ofOptional

booleanOptional

or

nullOptional

version_setsany ofOptional

or

nullOptional

tagsany ofOptional

or

nullOptional

tool_capacityany ofOptional

integer · min: 1 · max: 10Optional

or

nullOptional

Responses

200

Successful Response

application/json

idstringRequired

workspace_idstringRequired

namestringRequired

descriptionstringRequired

agent_idstringRequired

hsm_idstringRequired

agent_nameany ofOptional

stringOptional

or

nullOptional

hsm_nameany ofOptional

stringOptional

or

nullOptional

keytermsstring[]Required

is_activebooleanRequired

tool_capacityintegerRequired

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}

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "description": "text",
  "agent_id": "123e4567-e89b-12d3-a456-426614174000",
  "hsm_id": "123e4567-e89b-12d3-a456-426614174000",
  "keyterms": [
    "text"
  ],
  "is_active": true,
  "version_sets": {
    "ANY_ADDITIONAL_PROPERTY": {
      "agent_version_number": 1,
      "service_hierarchical_state_machine_version_number": 1,
      "llm_model_preferences": {
        "ANY_ADDITIONAL_PROPERTY": {
          "llm_name": "text",
          "params": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        }
      }
    }
  },
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "tool_capacity": 1
}

{
  "id": "text",
  "workspace_id": "text",
  "name": "text",
  "description": "text",
  "agent_id": "text",
  "hsm_id": "text",
  "agent_name": "text",
  "hsm_name": "text",
  "keyterms": [
    "text"
  ],
  "is_active": true,
  "version_sets": {
    "ANY_ADDITIONAL_PROPERTY": {
      "agent_version_number": 1,
      "service_hierarchical_state_machine_version_number": 1,
      "llm_model_preferences": {
        "ANY_ADDITIONAL_PROPERTY": {
          "llm_name": "text",
          "params": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        }
      }
    }
  },
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "tool_capacity": 1,
  "created_at": "2026-03-22T05:27:57.008Z",
  "updated_at": "2026-03-22T05:27:57.008Z"
}

Delete a service

delete

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

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

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

service_idstring · uuidRequired

Responses

204

Successful Response

401

Missing or invalid API key.

403

Insufficient permissions.

404

Not found.

422

Validation Error

application/json

delete

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

HTTPcURLJavaScriptPython

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

No content

Upsert a service version set

put

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

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

Replace or create a named version set on a service. The edge version set is immutable and cannot be updated. Pinned agent/HSM versions are validated.

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

service_idstring · uuidRequired

namestring · max: 40Required

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

Body

application/json

Responses

204

Successful Response

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}

HTTPcURLJavaScriptPython

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

{
  "version_set": {
    "agent_version_number": 1,
    "service_hierarchical_state_machine_version_number": 1,
    "llm_model_preferences": {
      "ANY_ADDITIONAL_PROPERTY": {
        "llm_name": "text",
        "params": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    }
  }
}

No content