Integrations

Bulk integration health check

get

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

/v1/{workspace_id}/integrations/health-check

Quick health status of all enabled integrations.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Responses

200

Successful Response

application/json

Other propertiesanyOptional

get

/v1/{workspace_id}/integrations/health-check

HTTPcURLJavaScriptPython

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

200

Successful Response

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

List integrations

get

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

/v1/{workspace_id}/integrations/

List integrations for a workspace with pagination. Optionally filter by enabled status. Requires Integration.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

enabledany ofOptional

booleanOptional

or

nullOptional

protocolany ofOptional

stringOptional

or

nullOptional

sort_byany ofOptional

stringOptional

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.

422

Validation Error

application/json

get

/v1/{workspace_id}/integrations/

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "id": "text",
      "workspace_id": "text",
      "name": "text",
      "display_name": "text",
      "protocol": "text",
      "base_url": "",
      "auth": {
        "type": "api_key_header",
        "header_name": "text",
        "ssm_param_path": "text",
        "token_ssm_param_path": "text",
        "token_url": "text",
        "client_id": "text",
        "client_secret_ssm_param_path": "text",
        "scopes": [
          "text"
        ],
        "gcp_scopes": [
          "text"
        ],
        "private_key_ssm_param_path": "text",
        "assertion_issuer": "text",
        "assertion_subject": "text",
        "assertion_audience": "text",
        "token_lifetime_seconds": 3600
      },
      "endpoints": [
        {
          "name": "text",
          "description": "text",
          "method": "POST",
          "path": "text",
          "base_url": "text",
          "auth": {
            "type": "api_key_header",
            "header_name": "text",
            "ssm_param_path": "text",
            "token_ssm_param_path": "text",
            "token_url": "text",
            "client_id": "text",
            "client_secret_ssm_param_path": "text",
            "scopes": [
              "text"
            ],
            "gcp_scopes": [
              "text"
            ],
            "private_key_ssm_param_path": "text",
            "assertion_issuer": "text",
            "assertion_subject": "text",
            "assertion_audience": "text",
            "token_lifetime_seconds": 3600
          },
          "input_schema": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "response_mapping": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "response_filter": [
            "text"
          ],
          "result_template": "text",
          "result_key": "text",
          "max_result_length": 0,
          "retry_config": {
            "max_retries": 2,
            "retry_on_status": [
              1
            ]
          },
          "result_delivery": "interrupt",
          "headers": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      ],
      "enabled": true,
      "builtin": false,
      "created_at": "2026-03-22T05:03:42.369Z",
      "updated_at": "2026-03-22T05:03:42.369Z",
      "mcp_transport": "text",
      "mcp_command": "text",
      "mcp_args": [
        "text"
      ],
      "mcp_url": "text",
      "mcp_headers": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "has_more": true,
  "continuation_token": 1
}

Create an integration

post

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

/v1/{workspace_id}/integrations/

Create a new external API integration in a workspace. Requires Integration.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

namestringRequired

display_namestring · min: 1Required

protocolstring · enumOptionalDefault: restPossible values:

base_urlstringOptionalDefault: ""

authany ofOptional

or

nullOptional

enabledbooleanOptionalDefault: true

mcp_transportany ofOptional

string · enumOptionalPossible values:

or

nullOptional

mcp_commandany ofOptional

stringOptional

or

nullOptional

mcp_argsany ofOptional

string[]Optional

or

nullOptional

mcp_urlany ofOptional

stringOptional

or

nullOptional

mcp_headersany ofOptional

or

nullOptional

Responses

201

Successful Response

application/json

401

Missing or invalid API key.

403

Insufficient permissions.

404

Workspace not found.

409

Integration name already taken in this workspace.

422

Invalid request body.

post

/v1/{workspace_id}/integrations/

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "display_name": "text",
  "protocol": "rest",
  "base_url": "",
  "auth": {
    "type": "api_key_header",
    "header_name": "text",
    "ssm_param_path": "text",
    "token_ssm_param_path": "text",
    "token_url": "text",
    "client_id": "text",
    "client_secret_ssm_param_path": "text",
    "scopes": [
      "text"
    ],
    "gcp_scopes": [
      "text"
    ],
    "private_key_ssm_param_path": "text",
    "assertion_issuer": "text",
    "assertion_subject": "text",
    "assertion_audience": "text",
    "token_lifetime_seconds": 3600,
    "api_key_value": {
      "value": "text"
    },
    "bearer_token_value": {
      "value": "text"
    },
    "client_secret_value": {
      "value": "text"
    },
    "private_key_value": {
      "value": "text"
    }
  },
  "endpoints": [
    {
      "name": "text",
      "description": "text",
      "method": "POST",
      "path": "text",
      "base_url": "text",
      "auth": {
        "type": "api_key_header",
        "header_name": "text",
        "ssm_param_path": "text",
        "token_ssm_param_path": "text",
        "token_url": "text",
        "client_id": "text",
        "client_secret_ssm_param_path": "text",
        "scopes": [
          "text"
        ],
        "gcp_scopes": [
          "text"
        ],
        "private_key_ssm_param_path": "text",
        "assertion_issuer": "text",
        "assertion_subject": "text",
        "assertion_audience": "text",
        "token_lifetime_seconds": 3600
      },
      "input_schema": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "response_mapping": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "response_filter": [
        "text"
      ],
      "result_template": "text",
      "result_key": "text",
      "max_result_length": 0,
      "retry_config": {
        "max_retries": 2,
        "retry_on_status": [
          1
        ]
      },
      "result_delivery": "interrupt",
      "headers": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "enabled": true,
  "mcp_transport": "stdio",
  "mcp_command": "text",
  "mcp_args": [
    "text"
  ],
  "mcp_url": "text",
  "mcp_headers": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

{
  "id": "text",
  "workspace_id": "text",
  "name": "text",
  "display_name": "text",
  "protocol": "text",
  "base_url": "",
  "auth": {
    "type": "api_key_header",
    "header_name": "text",
    "ssm_param_path": "text",
    "token_ssm_param_path": "text",
    "token_url": "text",
    "client_id": "text",
    "client_secret_ssm_param_path": "text",
    "scopes": [
      "text"
    ],
    "gcp_scopes": [
      "text"
    ],
    "private_key_ssm_param_path": "text",
    "assertion_issuer": "text",
    "assertion_subject": "text",
    "assertion_audience": "text",
    "token_lifetime_seconds": 3600
  },
  "endpoints": [
    {
      "name": "text",
      "description": "text",
      "method": "POST",
      "path": "text",
      "base_url": "text",
      "auth": {
        "type": "api_key_header",
        "header_name": "text",
        "ssm_param_path": "text",
        "token_ssm_param_path": "text",
        "token_url": "text",
        "client_id": "text",
        "client_secret_ssm_param_path": "text",
        "scopes": [
          "text"
        ],
        "gcp_scopes": [
          "text"
        ],
        "private_key_ssm_param_path": "text",
        "assertion_issuer": "text",
        "assertion_subject": "text",
        "assertion_audience": "text",
        "token_lifetime_seconds": 3600
      },
      "input_schema": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "response_mapping": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "response_filter": [
        "text"
      ],
      "result_template": "text",
      "result_key": "text",
      "max_result_length": 0,
      "retry_config": {
        "max_retries": 2,
        "retry_on_status": [
          1
        ]
      },
      "result_delivery": "interrupt",
      "headers": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "enabled": true,
  "builtin": false,
  "created_at": "2026-03-22T05:03:42.369Z",
  "updated_at": "2026-03-22T05:03:42.369Z",
  "mcp_transport": "text",
  "mcp_command": "text",
  "mcp_args": [
    "text"
  ],
  "mcp_url": "text",
  "mcp_headers": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Get an integration

get

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

/v1/{workspace_id}/integrations/{integration_id}

Retrieve an integration by ID. Requires Integration.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

integration_idstringRequired

Responses

200

Successful Response

application/json

idstringRequired

workspace_idstringRequired

namestringRequired

display_namestringRequired

protocolstringRequired

base_urlstringOptionalDefault: ""

authany ofOptional

or

nullOptional

enabledbooleanRequired

builtinbooleanOptionalDefault: false

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

mcp_transportany ofOptional

stringOptional

or

nullOptional

mcp_commandany ofOptional

stringOptional

or

nullOptional

mcp_argsany ofOptional

string[]Optional

or

nullOptional

mcp_urlany ofOptional

stringOptional

or

nullOptional

mcp_headersany ofOptional

or

nullOptional

401

Missing or invalid API key.

403

Insufficient permissions.

404

Integration not found.

422

Validation Error

application/json

get

/v1/{workspace_id}/integrations/{integration_id}

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "workspace_id": "text",
  "name": "text",
  "display_name": "text",
  "protocol": "text",
  "base_url": "",
  "auth": {
    "type": "api_key_header",
    "header_name": "text",
    "ssm_param_path": "text",
    "token_ssm_param_path": "text",
    "token_url": "text",
    "client_id": "text",
    "client_secret_ssm_param_path": "text",
    "scopes": [
      "text"
    ],
    "gcp_scopes": [
      "text"
    ],
    "private_key_ssm_param_path": "text",
    "assertion_issuer": "text",
    "assertion_subject": "text",
    "assertion_audience": "text",
    "token_lifetime_seconds": 3600
  },
  "endpoints": [
    {
      "name": "text",
      "description": "text",
      "method": "POST",
      "path": "text",
      "base_url": "text",
      "auth": {
        "type": "api_key_header",
        "header_name": "text",
        "ssm_param_path": "text",
        "token_ssm_param_path": "text",
        "token_url": "text",
        "client_id": "text",
        "client_secret_ssm_param_path": "text",
        "scopes": [
          "text"
        ],
        "gcp_scopes": [
          "text"
        ],
        "private_key_ssm_param_path": "text",
        "assertion_issuer": "text",
        "assertion_subject": "text",
        "assertion_audience": "text",
        "token_lifetime_seconds": 3600
      },
      "input_schema": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "response_mapping": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "response_filter": [
        "text"
      ],
      "result_template": "text",
      "result_key": "text",
      "max_result_length": 0,
      "retry_config": {
        "max_retries": 2,
        "retry_on_status": [
          1
        ]
      },
      "result_delivery": "interrupt",
      "headers": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "enabled": true,
  "builtin": false,
  "created_at": "2026-03-22T05:03:42.369Z",
  "updated_at": "2026-03-22T05:03:42.369Z",
  "mcp_transport": "text",
  "mcp_command": "text",
  "mcp_args": [
    "text"
  ],
  "mcp_url": "text",
  "mcp_headers": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Update an integration

put

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

/v1/{workspace_id}/integrations/{integration_id}

Update an integration's configuration. Requires Integration.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

integration_idstringRequired

Body

application/json

display_nameany ofOptional

string · min: 1Optional

or

nullOptional

protocolany ofOptional

string · enumOptionalPossible values:

or

nullOptional

base_urlany ofOptional

stringOptional

or

nullOptional

authany ofOptional

or

nullOptional

endpointsany ofOptional

or

nullOptional

enabledany ofOptional

booleanOptional

or

nullOptional

mcp_transportany ofOptional

string · enumOptionalPossible values:

or

nullOptional

mcp_commandany ofOptional

stringOptional

or

nullOptional

mcp_argsany ofOptional

string[]Optional

or

nullOptional

mcp_urlany ofOptional

stringOptional

or

nullOptional

mcp_headersany ofOptional

or

nullOptional

Responses

200

Successful Response

application/json

idstringRequired

workspace_idstringRequired

namestringRequired

display_namestringRequired

protocolstringRequired

base_urlstringOptionalDefault: ""

authany ofOptional

or

nullOptional

enabledbooleanRequired

builtinbooleanOptionalDefault: false

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

mcp_transportany ofOptional

stringOptional

or

nullOptional

mcp_commandany ofOptional

stringOptional

or

nullOptional

mcp_argsany ofOptional

string[]Optional

or

nullOptional

mcp_urlany ofOptional

stringOptional

or

nullOptional

mcp_headersany ofOptional

or

nullOptional

401

Missing or invalid API key.

403

Insufficient permissions.

404

Integration not found.

422

Invalid request body.

put

/v1/{workspace_id}/integrations/{integration_id}

HTTPcURLJavaScriptPython

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

{
  "display_name": "text",
  "protocol": "rest",
  "base_url": "text",
  "auth": {
    "type": "api_key_header",
    "header_name": "text",
    "ssm_param_path": "text",
    "token_ssm_param_path": "text",
    "token_url": "text",
    "client_id": "text",
    "client_secret_ssm_param_path": "text",
    "scopes": [
      "text"
    ],
    "gcp_scopes": [
      "text"
    ],
    "private_key_ssm_param_path": "text",
    "assertion_issuer": "text",
    "assertion_subject": "text",
    "assertion_audience": "text",
    "token_lifetime_seconds": 3600,
    "api_key_value": {
      "value": "text"
    },
    "bearer_token_value": {
      "value": "text"
    },
    "client_secret_value": {
      "value": "text"
    },
    "private_key_value": {
      "value": "text"
    }
  },
  "endpoints": [
    {
      "name": "text",
      "description": "text",
      "method": "POST",
      "path": "text",
      "base_url": "text",
      "auth": {
        "type": "api_key_header",
        "header_name": "text",
        "ssm_param_path": "text",
        "token_ssm_param_path": "text",
        "token_url": "text",
        "client_id": "text",
        "client_secret_ssm_param_path": "text",
        "scopes": [
          "text"
        ],
        "gcp_scopes": [
          "text"
        ],
        "private_key_ssm_param_path": "text",
        "assertion_issuer": "text",
        "assertion_subject": "text",
        "assertion_audience": "text",
        "token_lifetime_seconds": 3600
      },
      "input_schema": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "response_mapping": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "response_filter": [
        "text"
      ],
      "result_template": "text",
      "result_key": "text",
      "max_result_length": 0,
      "retry_config": {
        "max_retries": 2,
        "retry_on_status": [
          1
        ]
      },
      "result_delivery": "interrupt",
      "headers": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "enabled": true,
  "mcp_transport": "stdio",
  "mcp_command": "text",
  "mcp_args": [
    "text"
  ],
  "mcp_url": "text",
  "mcp_headers": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

{
  "id": "text",
  "workspace_id": "text",
  "name": "text",
  "display_name": "text",
  "protocol": "text",
  "base_url": "",
  "auth": {
    "type": "api_key_header",
    "header_name": "text",
    "ssm_param_path": "text",
    "token_ssm_param_path": "text",
    "token_url": "text",
    "client_id": "text",
    "client_secret_ssm_param_path": "text",
    "scopes": [
      "text"
    ],
    "gcp_scopes": [
      "text"
    ],
    "private_key_ssm_param_path": "text",
    "assertion_issuer": "text",
    "assertion_subject": "text",
    "assertion_audience": "text",
    "token_lifetime_seconds": 3600
  },
  "endpoints": [
    {
      "name": "text",
      "description": "text",
      "method": "POST",
      "path": "text",
      "base_url": "text",
      "auth": {
        "type": "api_key_header",
        "header_name": "text",
        "ssm_param_path": "text",
        "token_ssm_param_path": "text",
        "token_url": "text",
        "client_id": "text",
        "client_secret_ssm_param_path": "text",
        "scopes": [
          "text"
        ],
        "gcp_scopes": [
          "text"
        ],
        "private_key_ssm_param_path": "text",
        "assertion_issuer": "text",
        "assertion_subject": "text",
        "assertion_audience": "text",
        "token_lifetime_seconds": 3600
      },
      "input_schema": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "response_mapping": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "response_filter": [
        "text"
      ],
      "result_template": "text",
      "result_key": "text",
      "max_result_length": 0,
      "retry_config": {
        "max_retries": 2,
        "retry_on_status": [
          1
        ]
      },
      "result_delivery": "interrupt",
      "headers": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "enabled": true,
  "builtin": false,
  "created_at": "2026-03-22T05:03:42.369Z",
  "updated_at": "2026-03-22T05:03:42.369Z",
  "mcp_transport": "text",
  "mcp_command": "text",
  "mcp_args": [
    "text"
  ],
  "mcp_url": "text",
  "mcp_headers": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Delete an integration

delete

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

/v1/{workspace_id}/integrations/{integration_id}

Delete an integration. Requires Integration.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

integration_idstringRequired

Responses

204

Successful Response

401

Missing or invalid API key.

403

Insufficient permissions.

404

Integration not found.

422

Validation Error

application/json

delete

/v1/{workspace_id}/integrations/{integration_id}

HTTPcURLJavaScriptPython

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

No content

Test an integration endpoint

post

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

/v1/{workspace_id}/integrations/{integration_id}/endpoints/{endpoint_name}/test

Execute an integration endpoint with test parameters and return the full response pipeline breakdown. Requires Integration.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

integration_idstringRequired

endpoint_namestringRequired

Body

application/json

Responses

200

Successful Response

application/json

status_codeany ofOptional

integerOptional

or

nullOptional

duration_msnumberOptionalDefault: 0

retriesintegerOptionalDefault: 0

raw_responseanyOptional

after_filteranyOptional

after_mappinganyOptional

final_resultany ofOptional

stringOptional

or

nullOptional

errorany ofOptional

stringOptional

or

nullOptional

401

Missing or invalid API key.

403

Insufficient permissions.

404

Integration not found.

422

Validation Error

application/json

post

/v1/{workspace_id}/integrations/{integration_id}/endpoints/{endpoint_name}/test

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/integrations/{integration_id}/endpoints/{endpoint_name}/test HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "status_code": 1,
  "duration_ms": 0,
  "retries": 0,
  "raw_response": null,
  "after_filter": null,
  "after_mapping": null,
  "final_result": "text",
  "error": "text"
}