Skip to main content
GET
Get Agent Dynamic Variables

Overview

Use this endpoint to fetch the dynamic variables an agent expects at runtime. This is useful before:
  • placing outbound calls that need personalized values
  • creating Daily sessions with agent-specific runtime fields
  • building forms that collect required variables for a specific agent

Authentication

string
required
Your eigi.ai API key. Must be prefixed with vk_.

Path Parameters

string
required
The unique agent ID.Example: 68ea2517dbb84c09bae1ba0a

Response

string
The agent ID.
string
The agent name.
array
Normalized dynamic variable definitions configured for the agent.
string
Canonical variable key used in prompts and runtime payloads.
boolean
Whether the variable must be provided before starting the conversation.
string
Expected value type: STRING, NUMBER, EMAIL, or PHONE.
string
Guidance describing what value should be passed for that variable.

Example Use Cases

Fetch the dynamic variables for an agent, render the required fields in your UI, then collect the values before placing a call or creating a session.
Use the required and field_type fields to validate your payload before sending runtime values to eigi.ai.
Call this endpoint whenever an agent changes so your application always uses the latest variable definitions.

Notes

  • Variable names are normalized before they are returned.
  • If an agent has no configured dynamic variables, the endpoint returns an empty array.
  • This endpoint only returns variables for agents owned by the authenticated API key holder.

Authorizations

X-API-Key
string
header
required

API key for authentication. Get your API key from the eigi.ai Dashboard under Settings → API Keys.

Path Parameters

agent_id
string
required

The unique agent ID

Response

Successfully retrieved agent dynamic variables

agent_id
string

The agent ID

agent_name
string

The agent name

dynamic_variables
object[]

Normalized dynamic variable definitions configured for the agent