Agent Definitions

List Agent Definitions

get

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

frameworkstring · enum · nullableOptionalPossible values:

include_archivedbooleanOptionalDefault: false

limitinteger · max: 200OptionalDefault: 50

continuation_tokenanyOptional

Responses

200

Successful Response

application/json

has_morebooleanRequired

continuation_tokenanyOptional

422

Validation Error

application/json

get/v1/{workspace_id}/agent-definitions

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "definition_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "framework": "claude-agent-sdk",
      "status": "active"
    }
  ],
  "has_more": true,
  "continuation_token": null
}

Register Agent Definition

post

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: 2 · max: 63Required

Stable slug identifying this definition within the workspace.

Pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$

Responses

200

Successful Response

application/json

definition_idstring · uuidRequired

versionintegerRequired

createdbooleanRequired

False when an identical body was already registered (idempotent push).

frameworkstring · enumRequiredPossible values:

has_write_toolsbooleanRequired

agent_countintegerRequired

body_sha256stringRequired

422

Validation Error

application/json

post/v1/{workspace_id}/agent-definitions

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "definition_id": "123e4567-e89b-12d3-a456-426614174000",
  "version": 1,
  "created": true,
  "framework": "claude-agent-sdk",
  "has_write_tools": true,
  "agent_count": 1,
  "body_sha256": "text"
}

Validate Agent Definition

post

Dry-run clamp validation — nothing is stored. 422 with the offending paths on failure (the same shape push returns).

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: 2 · max: 63Required

Stable slug identifying this definition within the workspace.

Pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$

Responses

200

Successful Response

application/json

validconst: Required

frameworkstring · enumRequiredPossible values:

has_write_toolsbooleanRequired

agent_countintegerRequired

422

Validation Error

application/json

post/v1/{workspace_id}/agent-definitions/validate

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "valid": true,
  "framework": "claude-agent-sdk",
  "has_write_tools": true,
  "agent_count": 1
}

Get Agent Definition

get

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

definition_idstring · uuidRequired

Responses

200

Successful Response

application/json

definition_idstring · uuidRequired

namestringRequired

frameworkstring · enumRequiredPossible values:

statusstring · enumRequiredPossible values:

422

Validation Error

application/json

get/v1/{workspace_id}/agent-definitions/{definition_id}

HTTPcURLJavaScriptPython

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

{
  "definition_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "framework": "claude-agent-sdk",
  "status": "active",
  "versions": [
    {
      "version": 1,
      "body_sha256": "text",
      "validator_rev": "text",
      "has_write_tools": true,
      "agent_count": 1
    }
  ]
}

Archive Agent Definition

delete

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

definition_idstring · uuidRequired

Responses

204

Successful Response

No content

422

Validation Error

application/json

delete/v1/{workspace_id}/agent-definitions/{definition_id}

HTTPcURLJavaScriptPython

DELETE /v1/{workspace_id}/agent-definitions/{definition_id} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Agent Definition Version

get

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

definition_idstring · uuidRequired

versionintegerRequired

Responses

200

Successful Response

application/json

versionintegerRequired

body_sha256stringRequired

validator_revstringRequired

has_write_toolsbooleanRequired

agent_countintegerRequired

definition_idstring · uuidRequired

frameworkstring · enumRequiredPossible values:

422

Validation Error

application/json

get/v1/{workspace_id}/agent-definitions/{definition_id}/versions/{version}

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/agent-definitions/{definition_id}/versions/{version} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "version": 1,
  "body_sha256": "text",
  "validator_rev": "text",
  "has_write_tools": true,
  "agent_count": 1,
  "definition_id": "123e4567-e89b-12d3-a456-426614174000",
  "framework": "claude-agent-sdk",
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}