3 steps, live in 5 minutes
⚡01Create Agent
POST /api/v1/agents💬02Open Channel
POST /api/v1/agents/{agentId}/channels🤖03Send Message
POST /api/v1/agents/{agentId}/chatAuthentication
HTTP Header
Authorization: Bearer <YOUR_API_KEY>- All requests require HTTPS
- Use one API key per environment
- Never expose keys in frontend code
API Reference
Agent
Chat
Knowledge Base
POST
/api/v1/agentsCreate Agent
Create an agent and return agentId for KB binding and chat.
| Parameter | Type | Description |
|---|---|---|
agentDisplayName | stringRequired | Agent name (max 255 chars) |
agentDescription | stringOptional | Agent purpose |
agentToneStyle | stringOptional | Tone: PROFESSIONAL or CASUAL |
agentAnswerStrategy | stringOptional | Strategy: BALANCED / PRECISE / CREATIVE |
agentExecutionMode | stringOptional | Mode: CONVERSATION or REPORT |
ownerId | stringOptional | Owner ID for multi-tenant use |
Response
{
"agentId": 101,
"agentDisplayName": "Customer Support",
"agentStatus": "ACTIVE",
"agentCreateDate": "2026-04-01T09:00:00Z"
}Error Codes
400Bad RequestPayload format is invalid or required fields are missing
401UnauthorizedAPI key is missing or invalid
404Not FoundTarget resource does not exist
422UnprocessableField values are outside the allowed range
429Rate LimitedRequest rate is too high
500Server ErrorUnexpected server error, retry later
Official SDKs (7 languages)
Each language has an official standalone GitHub repository so customers can clone and integrate with minimal manual change.
npm install @egroupai/ai-sandbox-sdk-typescriptOpen GitHub repopip install ai-sandbox-sdk-pythonOpen GitHub repoMaven: com.egroupai:ai-sandbox-sdk-javaOpen GitHub repoNuGet: EGroupAI.AiSandbox.SdkOpen GitHub repogo get github.com/eGroupAI/ai-sandbox-sdk-goOpen GitHub repocomposer require egroupai/ai-sandbox-sdk-phpOpen GitHub repogem install ai-sandbox-sdk-rubyOpen GitHub repoSwitch host to go live
Demo and production share the same API paths. Change only the host and key to promote to production.