Skip to main content
GET
Get conversational Agent

Authorizations

X-API-Key
string
header
required

Authenticate every request by passing your API key in the X-API-Key header. To get your key, go to Dashboard → API Keys and create or copy your Production API key.

Path Parameters

agentId
string
required

Unique identifier of the agent to be retrieved.

Response

OK

agentId
string

The unique identifier of the agent within the system.

Example:

"SPIlVscbB0kkXBvZ"

agentName
string

Human-readable name of the agent used to identify it in the dashboard and APIs.

Example:

"Auralis"

startNodeName
string

The name of the node where the agent workflow starts.

Example:

"Welcome"

startNodeId
string

The unique identifier of the node where the agent workflow starts.

Example:

"node_01HXYZ123"

agentSettings
object

Configuration settings that define the agent’s runtime behavior, including voice, llm model and other operational settings.

nodes
object[]

Sends a response to the user before continuing to the next node in the workflow.