Skip to content

Api

.halguru.yaml ➤ Channels[] ➤ Api

Gets or sets the API channel path associated with the communication channel.

Channels:
  - Api:
      Name: API Channel
      Description: |
        An API channel for integration.
      Active: true
      RequiredUserType: Anonymous

Field Information#

Name Description
Title Api
Field Type Object
Required False

Field List#

Name Type Required Description
Name Text ✔️ The name of the channel.
Description MultilineText A description of the API channel.
Active Boolean ✔️ Whether the channel is active or not.
RequiredUserType Choice ✔️ The type of user required to access the channel.

Technical Information#

Property Value
Path Channels[].Api
Internal Type AgentModels.ChannelModels.ApiChannel
Internal Root Type AgentHalGuru
File Extension .halguru.yaml
JSON Schema halguru-schema.json

→ .halguru.yaml#

→ Reference Index#

→ Configuration Files#

Last updated: 2026-03-19
Autogenerated: Yes
AI powered: Yes
Core version: 1.93.0