Download OpenAPI specification:Download
Execute core operations on the HALO platform
Retrieve culture by code.
Required permission: HALO.Core_Cultures_Read
| account_id required | string <uuid> Account identifier |
| culture_code required | string Culture identifier |
{- "code": "string",
- "name": "string"
}Retrieve all profiles for an account.
Required permission: HALO.Core_Profiles_Read
| account_id required | string <uuid> Account identifier |
[- {
- "id": 0,
- "name": "string",
- "workspace_type": "conversational"
}
]Retrieve profile by ID.
Required permission: HALO.Core_Profiles_Read
| account_id required | string <uuid> Account identifier |
| profile_id required | integer <int64> Profile identifier |
{- "id": 0,
- "name": "string",
- "workspace_type": "conversational"
}Retrieve a conversation by ID.
Required permission: HALO.Core_Conversations_Read
| account_id required | string <uuid> Account identifier |
| profile_id required | integer <int64> Profile identifier |
| conversation_id required | string <uuid> Conversation identifier |
| view | string View mode for conversation (default: transcript) |
nullHandover a conversation to a different agent or system.
Required permission: HALO.Core_Conversations_Handover
| account_id required | string <uuid> Account identifier |
| profile_id required | integer <int64> Profile identifier |
| conversation_id required | string <uuid> Conversation identifier |
required | object |
Array of objects or objects or objects or (object or objects or objects) or objects or null (ContentPart) | |
| target_state_name_id required | string <uuid> |
| type required | string Value: "text_router_v2" |
{- "type": "voice_logging"
}