Config - HaloAgents

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

string

required

Your organization ID (UUID format).

Response

object

The active agent’s configuration.

Show child attributes

string

Agent UUID.

string

Agent display name.

array

Enabled skill identifiers.

object

HeyGen streaming avatar settings.

object

ElevenLabs voice settings.

object

Ordered conversation flow steps and custom variables. Defaults to { "steps": [], "custom_variables": [] } if not configured.

string

Custom label for the Live Help button. Defaults to "Live Help".

string

How the video avatar is displayed: "modal" or "inline". Defaults to "modal".

string

Agent status ("active").

object

Organization-level settings.

Show child attributes

string

Organization display name.

object

Public organization settings. Sensitive fields like global_instructions are redacted.

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": {}
  }
}

​Endpoint

​Authentication

​Query Parameters

​Response

​Example

Endpoint

Authentication

Query Parameters

Response

Example