Skip to main content
GET
/
v1
/
public
/
agents
/
{agent_id}
/
dynamic-variables
Get Agent Dynamic Variables
curl --request GET \
  --url https://api.eigi.ai/v1/public/agents/{agent_id}/dynamic-variables \
  --header 'X-API-Key: <api-key>'
{
  "agent_id": "<string>",
  "agent_name": "<string>",
  "dynamic_variables": [
    {
      "variable_name": "<string>",
      "required": false,
      "description": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.eigi.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
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

​
X-API-Key
string
required
Your eigi.ai API key. Must be prefixed with vk_.

​
Path Parameters

​
agent_id
string
required
The unique agent ID.Example: 68ea2517dbb84c09bae1ba0a

​
Response

​
agent_id
string
The agent ID.
​
agent_name
string
The agent name.
​
dynamic_variables
array
Normalized dynamic variable definitions configured for the agent.
​
dynamic_variables[].variable_name
string
Canonical variable key used in prompts and runtime payloads.
​
dynamic_variables[].required
boolean
Whether the variable must be provided before starting the conversation.
​
dynamic_variables[].field_type
string
Expected value type: STRING, NUMBER, EMAIL, or PHONE.
​
dynamic_variables[].description
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