For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Platform docsVideosCommunitySign up
CapabilitiesGetting startedVoice AI OrchestrationVoxEngine PlatformAPI ReferenceFAQ
CapabilitiesGetting startedVoice AI OrchestrationVoxEngine PlatformAPI ReferenceFAQ
      • Overview
        • Cartesia
          • Overview
          • Agent
          • Conversation
          • Participant
        • Deepgram
        • ElevenLabs
        • Gemini
        • Grok
        • Inworld
        • OpenAI
        • Pipecat
        • Ultravox
        • Yandex
  • Management API
    • Reference
    • Authorization
    • Errors
  • Web SDK
    • Overview
  • Android SDK
    • Overview
  • Android SDK v3
    • Overview
  • iOS SDK
    • Overview
  • React Native SDK
    • Overview
  • Flutter SDK
    • Overview
LogoLogo
Platform docsVideosCommunitySign up
On this page
  • Constructor
  • Methods
  • addEventListener
  • destroy
  • getConversationProfile
  • getProfilesList
  • id
  • removeEventListener
  • updateConversationProfile
VoxEngineVoice AICCAI

Agent

Represents a CCAI Agent instance.
||View as Markdown|
Was this page helpful?
Edit this page
Previous

CCAI

Next

Conversation

Built with

Constructor

1new Agent(agentId: string, region?: string)

Parameters

agentId
stringRequired
region
string
1new Agent(agentId: string, region?: string)

Parameters

agentId
stringRequired
region
string

Methods

addEventListener

Adds a handler for the specified CCAI.Events.Agent event. Use only functions as handlers; anything except a function leads to an error and scenario termination when a handler is called.

1addEventListener(event: CCAI.Events.Agent | T, callback: (event: CCAI.Events._AgentEvents[T]) => any): void

Parameters

event
CCAI.Events.Agent | TRequired
callback
(event: CCAI.Events._AgentEvents[T]) => anyRequired

destroy

Destroys a CCAI Agent instance.

1destroy(): void

getConversationProfile

Gets the Dialogflow conversation profile.

1getConversationProfile(request: Object): Promise<GetConversationProfileResult>

Parameters

request
ObjectRequired

getProfilesList

Gets the list of a Dialogflow conversation profiles.

1getProfilesList(): Promise<GetProfilesListResult>

id

Returns the CCAI Agent id.

1id(): string

removeEventListener

Removes a handler for the specified CCAI.Events.Agent event.

1removeEventListener(event: CCAI.Events.Agent | T, callback?: (event: CCAI.Events._AgentEvents[T]) => any): void

Parameters

event
CCAI.Events.Agent | TRequired
callback
(event: CCAI.Events._AgentEvents[T]) => any

updateConversationProfile

Updates the Dialogflow conversation profile.

1updateConversationProfile(request: Object): Promise<UpdateConversationProfileResult>

Parameters

request
ObjectRequired