MetorialDocs

Integration Instance Groups

Integration instance groups combine instance providers into a grouped routed configuration.

The Integration Instance Group object

integration_instance_group.json
{
  "object": "integration.instance.group",
  "id": "example_id",
  "status": "draft",
  "name": "example_name",
  "description": "example_description",
  "metadata": {},
  "implementation": {
    "type": "magic_mcp_endpoint",
    "magic_mcp_endpoint_id": "example_magic_mcp_endpoint_id"
  },
  "providers": [
    {
      "object": "integration.instance.group.provider",
      "status": "active",
      "metadata": {},
      "tool_filter": {
        "type": "allow_all"
      }
    },
    {
      "object": "integration.instance.group.provider",
      "status": "active",
      "metadata": {},
      "tool_filter": {
        "type": "allow_all"
      }
    }
  ],
  "created_at": "2026-09-11T20:30:32.758Z",
  "updated_at": "2026-09-11T20:30:32.758Z",
  "archived_at": "2026-09-11T20:30:32.758Z"
}
object"integration.instance.group"required
idstringrequired
status"draft" | "active" | "archived" | "deleted"required
namestringrequired
descriptionstringrequirednullable
metadataRecord<string, any>requirednullable
created_atdaterequired
updated_atdaterequired
archived_atdaterequirednullable

Endpoints

List integration instance groups

GET/integration-instance-groups

Returns a paginated list of integration instance groups.

Query parameters

status"draft" | "active" | "archived" | "deleted" or "draft" | "active" | "archived" | "deleted"[]optional
idstring or string[]optional
integration_idstring or string[]optional
integration_instance_idstring or string[]optional
integration_instance_provider_idstring or string[]optional
provider_idstring or string[]optional
integration_provider_idstring or string[]optional
provider_deployment_idstring or string[]optional
provider_config_idstring or string[]optional
provider_auth_config_idstring or string[]optional
session_template_idstring or string[]optional

Example request

curl -X GET "https://api.metorial.com/integration-instance-groups" \
  -H "Authorization: Bearer metorial_sk_io2h4..."

Get integration instance group

GET/integration-instance-groups/:integration_instance_group_id

Retrieves a specific integration instance group.

Path parameters

integration_instance_group_idstringrequired

The unique identifier for the integration_instance_group

Example request

curl -X GET "https://api.metorial.com/integration-instance-groups/int_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_io2h4..."

Create integration instance group session template

POST/integration-instance-groups/:integration_instance_group_id/session-template

Creates or updates the shared session template for a specific integration instance group.

Path parameters

integration_instance_group_idstringrequired

The unique identifier for the integration_instance_group

Request body

namestringoptional
descriptionstringoptional
metadataRecord<string, any>optional

Example request

curl -X POST "https://api.metorial.com/integration-instance-groups/int_Rm4Mnheq2bfEPhBhP7SY/session-template" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_io2h4..." \
  -d '{
  "name": "example_name",
  "description": "example_description",
  "metadata": {}
}'

Create integration instance group session

POST/integration-instance-groups/:integration_instance_group_id/session

Creates a session from the shared session template of a specific integration instance group.

Path parameters

integration_instance_group_idstringrequired

The unique identifier for the integration_instance_group

Request body

namestringoptional
descriptionstringoptional
metadataRecord<string, any>optional

Example request

curl -X POST "https://api.metorial.com/integration-instance-groups/int_Rm4Mnheq2bfEPhBhP7SY/session" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_io2h4..." \
  -d '{
  "name": "example_name",
  "description": "example_description",
  "metadata": {}
}'

Create integration instance group

POST/integration-instance-groups

Creates a new integration instance group.

Request body

namestringrequired
descriptionstringoptional
metadataRecord<string, any>optional

Example request

curl -X POST "https://api.metorial.com/integration-instance-groups" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_io2h4..." \
  -d '{
  "name": "example_name",
  "description": "example_description",
  "metadata": {},
  "providers": [
    {
      "tool_filters": {
        "type": "tool_keys"
      }
    },
    {
      "tool_filters": {
        "type": "tool_keys"
      }
    }
  ]
}'

Update integration instance group

PATCH/integration-instance-groups/:integration_instance_group_id

Updates a specific integration instance group.

Path parameters

integration_instance_group_idstringrequired

The unique identifier for the integration_instance_group

Request body

namestringoptional
descriptionstringoptionalnullable
metadataRecord<string, any>optionalnullable

Example request

curl -X PATCH "https://api.metorial.com/integration-instance-groups/int_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_io2h4..." \
  -d '{
  "name": "example_name",
  "description": "example_description",
  "metadata": {},
  "providers": [
    {
      "tool_filters": {
        "type": "tool_keys"
      }
    },
    {
      "tool_filters": {
        "type": "tool_keys"
      }
    }
  ]
}'

Delete integration instance group

DELETE/integration-instance-groups/:integration_instance_group_id

Archives a specific integration instance group.

Path parameters

integration_instance_group_idstringrequired

The unique identifier for the integration_instance_group

Example request

curl -X DELETE "https://api.metorial.com/integration-instance-groups/int_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_io2h4..."