Skip to main content

​
Endpoint

GET /api/sdk/config?org_id=your-org-id
Returns the active agent’s configuration and organization settings. Used by the widget to load its configuration (agent name, skills, voice/avatar config, flow steps).

​
Authentication

This endpoint is unauthenticated. It uses an org_id query parameter instead of an API key. This allows the widget to load configuration before authentication is established. Sensitive fields like agent instructions are redacted from the response.

​
Query Parameters

​
org_id
string
required
Your organization ID (UUID format).

​
Response

​
agent
object
The active agent’s configuration.
​
organization
object
Organization-level settings.

​
Example

curl "https://api.haloagents.ai/api/sdk/config?org_id=your-org-id"
Response: 
{
  "agent": {
    "id": "agent-uuid",
    "name": "Support Bot",
    "skills": ["web_search", "ticket_creation"],
    "avatar_config": {},
    "voice_config": {},
    "flow_config": { "steps": [], "custom_variables": [] },
    "live_help_label": "Live Help",
    "video_display_mode": "modal",
    "status": "active"
  },
  "organization": {
    "name": "Your Company",
    "settings": {}
  }
}