Skip to content

Agent Connections API

Manage agent-to-agent connections.

Endpoints

MethodEndpointDescription
GET/api/agents/{id}/agent-connectionsList connections
POST/api/agents/{id}/agent-connectionsCreate connection
GET/api/agents/{id}/agent-connections/{connectionId}Get connection
PUT/api/agents/{id}/agent-connections/{connectionId}Update connection

List Connections

bash
GET /api/agents/{id}/agent-connections

Response

json
{
  "connections": [
    {
      "id": "conn-123",
      "source_agent_id": "agent-a",
      "target_agent_id": "agent-b",
      "connection_type": "webhook",
      "config": {
        "events": ["workflow.complete"]
      },
      "created_at": "2024-12-01T00:00:00Z"
    }
  ]
}

Create Connection

bash
POST /api/agents/{id}/agent-connections
Content-Type: application/json

Request Body

json
{
  "target_agent_id": "agent-b",
  "connection_type": "webhook",
  "config": {
    "url": "https://agent-b.example.com/webhook",
    "events": ["workflow.complete", "message.received"]
  }
}

Get Connection

bash
GET /api/agents/{id}/agent-connections/{connectionId}

Update Connection

bash
PUT /api/agents/{id}/agent-connections/{connectionId}

Connection Types

TypeDescription
webhookHTTP POST events
directDirect DO communication

Event Types

EventDescription
workflow.completeWorkflow finished
workflow.errorWorkflow failed
message.receivedNew message
schedule.executedSchedule ran

Released under the MIT License.