Skip to content
Core ConceptsCLI ReferenceAPI Reference
CompozyOS RuntimeAPI Reference

Bundles

Compozy Bundles HTTP endpoints.

Audience
Operators running durable agent work
Focus
API Reference guidance shaped for scanability, day-two clarity, and operator context.

List active bundle preset activations

GET/api/bundles/activations

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/bundles/activations"
{  "activations": [    {      "agents": [        {          "category_path": [            "string"          ],          "has_heartbeat": true,          "has_soul": true,          "id": "string",          "model": "string",          "name": "string",          "provider": "string"        }      ],      "bridges": [        {          "display_name": "string",          "extension_name": "string",          "id": "string",          "name": "string",          "platform": "string",          "secret_slots": [            {              "description": "string",              "kind": "string",              "name": "string"            }          ]        }      ],      "bundle_description": "string",      "bundle_name": "string",      "channels": [        {          "description": "string",          "name": "string",          "primary": true        }      ],      "created_at": "2019-08-24T14:15:22Z",      "extension_name": "string",      "id": "string",      "inventory": [        {          "resource_id": "string",          "resource_kind": "string",          "resource_name": "string"        }      ],      "jobs": [        {          "agent_name": "string",          "enabled": true,          "id": "string",          "name": "string"        }      ],      "layouts": [        {          "aspect_variant": "string",          "display_name": "string",          "id": "string",          "overflow_policy": "string",          "participant_slots": [            "string"          ]        }      ],      "network_requirement_confirmed_at": "string",      "network_requirement_confirmed_by": "string",      "network_requirement_digest": "string",      "profile_description": "string",      "profile_name": "string",      "scope": "string",      "spec_drift": true,      "triggers": [        {          "agent_name": "string",          "enabled": true,          "event": "string",          "id": "string",          "name": "string"        }      ],      "updated_at": "2019-08-24T14:15:22Z",      "version": 0,      "workspace_id": "string"    }  ]}

Activate one extension bundle preset

POST/api/bundles/activations

Request Body

application/json

JSON request body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/bundles/activations" \  -H "Content-Type: application/json" \  -d '{    "bundle_name": "string",    "extension_name": "string",    "profile_name": "string"  }'
{  "activation": {    "agents": [      {        "category_path": [          "string"        ],        "has_heartbeat": true,        "has_soul": true,        "id": "string",        "model": "string",        "name": "string",        "provider": "string"      }    ],    "bridges": [      {        "display_name": "string",        "extension_name": "string",        "id": "string",        "name": "string",        "platform": "string",        "secret_slots": [          {            "description": "string",            "kind": "string",            "name": "string"          }        ]      }    ],    "bundle_description": "string",    "bundle_name": "string",    "channels": [      {        "description": "string",        "name": "string",        "primary": true      }    ],    "created_at": "2019-08-24T14:15:22Z",    "extension_name": "string",    "id": "string",    "inventory": [      {        "resource_id": "string",        "resource_kind": "string",        "resource_name": "string"      }    ],    "jobs": [      {        "agent_name": "string",        "enabled": true,        "id": "string",        "name": "string"      }    ],    "layouts": [      {        "aspect_variant": "string",        "display_name": "string",        "id": "string",        "overflow_policy": "string",        "participant_slots": [          "string"        ]      }    ],    "network_requirement_confirmed_at": "string",    "network_requirement_confirmed_by": "string",    "network_requirement_digest": "string",    "profile_description": "string",    "profile_name": "string",    "scope": "string",    "spec_drift": true,    "triggers": [      {        "agent_name": "string",        "enabled": true,        "event": "string",        "id": "string",        "name": "string"      }    ],    "updated_at": "2019-08-24T14:15:22Z",    "version": 0,    "workspace_id": "string"  }}

Get one bundle activation

GET/api/bundles/activations/{id}

Path Parameters

id*string

Bundle activation id

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/bundles/activations/string"
{  "activation": {    "agents": [      {        "category_path": [          "string"        ],        "has_heartbeat": true,        "has_soul": true,        "id": "string",        "model": "string",        "name": "string",        "provider": "string"      }    ],    "bridges": [      {        "display_name": "string",        "extension_name": "string",        "id": "string",        "name": "string",        "platform": "string",        "secret_slots": [          {            "description": "string",            "kind": "string",            "name": "string"          }        ]      }    ],    "bundle_description": "string",    "bundle_name": "string",    "channels": [      {        "description": "string",        "name": "string",        "primary": true      }    ],    "created_at": "2019-08-24T14:15:22Z",    "extension_name": "string",    "id": "string",    "inventory": [      {        "resource_id": "string",        "resource_kind": "string",        "resource_name": "string"      }    ],    "jobs": [      {        "agent_name": "string",        "enabled": true,        "id": "string",        "name": "string"      }    ],    "layouts": [      {        "aspect_variant": "string",        "display_name": "string",        "id": "string",        "overflow_policy": "string",        "participant_slots": [          "string"        ]      }    ],    "network_requirement_confirmed_at": "string",    "network_requirement_confirmed_by": "string",    "network_requirement_digest": "string",    "profile_description": "string",    "profile_name": "string",    "scope": "string",    "spec_drift": true,    "triggers": [      {        "agent_name": "string",        "enabled": true,        "event": "string",        "id": "string",        "name": "string"      }    ],    "updated_at": "2019-08-24T14:15:22Z",    "version": 0,    "workspace_id": "string"  }}

Update mutable bundle activation overlays

PATCH/api/bundles/activations/{id}

Path Parameters

id*string

Bundle activation id

Request Body

application/json

JSON request body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/bundles/activations/string" \  -H "Content-Type: application/json" \  -d '{    "expected_version": 0  }'
{  "activation": {    "agents": [      {        "category_path": [          "string"        ],        "has_heartbeat": true,        "has_soul": true,        "id": "string",        "model": "string",        "name": "string",        "provider": "string"      }    ],    "bridges": [      {        "display_name": "string",        "extension_name": "string",        "id": "string",        "name": "string",        "platform": "string",        "secret_slots": [          {            "description": "string",            "kind": "string",            "name": "string"          }        ]      }    ],    "bundle_description": "string",    "bundle_name": "string",    "channels": [      {        "description": "string",        "name": "string",        "primary": true      }    ],    "created_at": "2019-08-24T14:15:22Z",    "extension_name": "string",    "id": "string",    "inventory": [      {        "resource_id": "string",        "resource_kind": "string",        "resource_name": "string"      }    ],    "jobs": [      {        "agent_name": "string",        "enabled": true,        "id": "string",        "name": "string"      }    ],    "layouts": [      {        "aspect_variant": "string",        "display_name": "string",        "id": "string",        "overflow_policy": "string",        "participant_slots": [          "string"        ]      }    ],    "network_requirement_confirmed_at": "string",    "network_requirement_confirmed_by": "string",    "network_requirement_digest": "string",    "profile_description": "string",    "profile_name": "string",    "scope": "string",    "spec_drift": true,    "triggers": [      {        "agent_name": "string",        "enabled": true,        "event": "string",        "id": "string",        "name": "string"      }    ],    "updated_at": "2019-08-24T14:15:22Z",    "version": 0,    "workspace_id": "string"  }}

Deactivate one bundle preset and remove owned projected resources

DELETE/api/bundles/activations/{id}

Path Parameters

id*string

Bundle activation id

Response Body

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/bundles/activations/string"
Empty

List available extension bundle presets

GET/api/bundles/catalog

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/bundles/catalog"
{  "bundles": [    {      "bundle_name": "string",      "description": "string",      "extension_name": "string",      "profiles": [        {          "agent_count": 0,          "bridge_count": 0,          "channels": [            {              "description": "string",              "name": "string",              "primary": true            }          ],          "description": "string",          "job_count": 0,          "layout_count": 0,          "name": "string",          "primary_channel": "string",          "trigger_count": 0        }      ]    }  ]}

Get bundle-derived network defaults and declared channels

GET/api/bundles/network/settings

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/bundles/network/settings"
{  "network": {    "declared_channels": [      {        "activation_id": "string",        "bundle_name": "string",        "description": "string",        "extension_name": "string",        "name": "string",        "primary": true,        "profile_name": "string",        "workspace_id": "string"      }    ]  }}

Preview one bundle activation without mutating runtime resources

POST/api/bundles/preview

Request Body

application/json

JSON request body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/bundles/preview" \  -H "Content-Type: application/json" \  -d '{    "bundle_name": "string",    "extension_name": "string",    "profile_name": "string"  }'
{  "activation": {    "agents": [      {        "category_path": [          "string"        ],        "has_heartbeat": true,        "has_soul": true,        "id": "string",        "model": "string",        "name": "string",        "provider": "string"      }    ],    "bridges": [      {        "display_name": "string",        "extension_name": "string",        "id": "string",        "name": "string",        "platform": "string",        "secret_slots": [          {            "description": "string",            "kind": "string",            "name": "string"          }        ]      }    ],    "bundle_description": "string",    "bundle_name": "string",    "channels": [      {        "description": "string",        "name": "string",        "primary": true      }    ],    "created_at": "2019-08-24T14:15:22Z",    "extension_name": "string",    "id": "string",    "inventory": [      {        "resource_id": "string",        "resource_kind": "string",        "resource_name": "string"      }    ],    "jobs": [      {        "agent_name": "string",        "enabled": true,        "id": "string",        "name": "string"      }    ],    "layouts": [      {        "aspect_variant": "string",        "display_name": "string",        "id": "string",        "overflow_policy": "string",        "participant_slots": [          "string"        ]      }    ],    "network_requirement_confirmed_at": "string",    "network_requirement_confirmed_by": "string",    "network_requirement_digest": "string",    "profile_description": "string",    "profile_name": "string",    "scope": "string",    "spec_drift": true,    "triggers": [      {        "agent_name": "string",        "enabled": true,        "event": "string",        "id": "string",        "name": "string"      }    ],    "updated_at": "2019-08-24T14:15:22Z",    "version": 0,    "workspace_id": "string"  }}

Resources

Compozy Resources HTTP endpoints.

Automation

Compozy Automation HTTP endpoints.