Integration Methods

There are multiple ways to integrate AgentPlat into an application that you run and operate in your own infrastructure.

• Application UI: Build the user interface for your product or operations console and connect it to your AgentPlat deployment.
• REST API: Connect your applications programmatically to the AgentPlat services running in your infrastructure.
• Authentication: Configure authentication and authorization through your own identity provider and deployment boundary.

AgentPlat does not provide a hosted dashboard, hosted API, or managed runtime. The open-source software is intended to be deployed and operated by each adopting organization.

Common Integration Pitfalls

When integrating with the API, be aware of these common issues to ensure smooth operation.

1. Agent Role Object Structure

When listing agents, the role field is returned as a JSON Object, NOT a string. Attempting to parse it as a string will cause deserialization errors in strongly-typed languages like Go, Java, or C#.

// Correct Structure:
{
  "id": "agent_123",
  "role": {
    "id": "role_456",
    "name": "Copywriter"
  }
}

Go Example Fix:

// WRONG:
type Agent struct {
    Role string `json:"role"`
}
 
// CORRECT:
type AgentRole struct {
    ID   string `json:"id"`
    Name string `json:"name"`
}
type Agent struct {
    Role *AgentRole `json:"role"`
}