Create Agent - eigi.ai Documentation

Create Agent

curl --request POST \
  --url https://api.eigi.ai/v1/public/agents \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "agent_name": "Support Agent",
  "agent_type": "INBOUND",
  "agent_category": "Customer Service",
  "stt": {
    "provider_name": "DEEPGRAM",
    "model_name": "nova-2",
    "language": "en",
    "params": {}
  },
  "llm": {
    "provider_name": "OPENAI",
    "model_name": "gpt-4o",
    "params": {
      "temperature": 0.7
    }
  },
  "tts": {
    "provider_name": "CARTESIA",
    "model_name": "sonic-2",
    "language": "en",
    "voice_id": "a0e99841-438c-4a64-b679-ae501e7d6091",
    "params": {
      "speed": 1
    }
  },
  "prompt_content": "You are a helpful customer support agent.",
  "first_message_prompt": "Hello! How can I help you today?",
  "tools": {
    "end_call": true,
    "transfer_call": {
      "transfer_phone_number": "+919876543210"
    }
  }
}
'

{
  "id": "<string>",
  "agent_name": "<string>",
  "agent_description": "<string>",
  "agent_category": "<string>",
  "agent_tips": [
    "<string>"
  ],
  "agent_mobile_number": [
    "<string>"
  ],
  "stt": {},
  "llm": {},
  "tts": {},
  "sts": {},
  "prompt": {
    "prompt_name": "<string>",
    "prompt_version": 123,
    "prompt_content": "<string>"
  },
  "first_message_prompt": "<string>",
  "dynamic_variables": [
    "<string>"
  ],
  "tools": {},
  "widget_config": {},
  "MediaFiles": [
    {
      "fileType": "<string>",
      "mediaUrl": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

POST

public

agents

Create Agent

curl --request POST \
  --url https://api.eigi.ai/v1/public/agents \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "agent_name": "Support Agent",
  "agent_type": "INBOUND",
  "agent_category": "Customer Service",
  "stt": {
    "provider_name": "DEEPGRAM",
    "model_name": "nova-2",
    "language": "en",
    "params": {}
  },
  "llm": {
    "provider_name": "OPENAI",
    "model_name": "gpt-4o",
    "params": {
      "temperature": 0.7
    }
  },
  "tts": {
    "provider_name": "CARTESIA",
    "model_name": "sonic-2",
    "language": "en",
    "voice_id": "a0e99841-438c-4a64-b679-ae501e7d6091",
    "params": {
      "speed": 1
    }
  },
  "prompt_content": "You are a helpful customer support agent.",
  "first_message_prompt": "Hello! How can I help you today?",
  "tools": {
    "end_call": true,
    "transfer_call": {
      "transfer_phone_number": "+919876543210"
    }
  }
}
'

{
  "id": "<string>",
  "agent_name": "<string>",
  "agent_description": "<string>",
  "agent_category": "<string>",
  "agent_tips": [
    "<string>"
  ],
  "agent_mobile_number": [
    "<string>"
  ],
  "stt": {},
  "llm": {},
  "tts": {},
  "sts": {},
  "prompt": {
    "prompt_name": "<string>",
    "prompt_version": 123,
    "prompt_content": "<string>"
  },
  "first_message_prompt": "<string>",
  "dynamic_variables": [
    "<string>"
  ],
  "tools": {},
  "widget_config": {},
  "MediaFiles": [
    {
      "fileType": "<string>",
      "mediaUrl": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Overview

Create a new AI agent with full configuration including speech-to-text (STT), large language model (LLM), text-to-speech (TTS), prompt, tools, and widget settings.

Prompt Configuration

You can configure the agent’s prompt in two ways:

Inline prompt (prompt_content) — Provide the prompt text directly. An internal prompt is auto-created for the agent.
Prompt reference (prompt) — Reference an existing prompt by name and optionally version.

Provider Restrictions (Public API)

Provider	Allowed params
STT	No params allowed (must be empty `{}`)
LLM	Only `temperature` (0.0 - 2.0)
TTS	Only `speed`

Authentication

X-API-Key

string

required

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

Request Body

agent_name

string

required

Agent name (1-100 characters).

agent_type

string

required

Agent type: INBOUND or OUTBOUND.

stt

object

required

Speech-to-Text configuration.

Show properties

provider_name

string

required

STT provider: DEEPGRAM or WHISPER.

model_name

string

required

Model name (e.g., nova-2).

language

string

required

Language code (e.g., en, hi).

llm

object

required

Large Language Model configuration.

Show properties

provider_name

string

required

LLM provider: OPENAI, ANTHROPIC, GOOGLE, or GROK.

model_name

string

required

Model name (e.g., gpt-4o).

params

object

Only temperature (0.0-2.0) is allowed.

tts

object

required

Text-to-Speech configuration.

Show properties

provider_name

string

required

TTS provider: CARTESIA, ELEVENLABS, SARVAM, GOOGLE, or HUME.

model_name

string

required

Model name (e.g., sonic-2).

language

string

required

Language code.

voice_id

string

required

Voice ID from the provider. Use the List Voices endpoint to find available voices.

params

object

Only speed is allowed.

agent_description

string

Agent description (max 500 characters).

agent_category

string

default:"other"

Agent category (e.g., Customer Service, Sales, Healthcare, etc.).

agent_tips

array

Array of usage tip strings for the agent.

agent_mobile_number

array

Mobile numbers to associate with the agent.

prompt_content

string

Inline prompt content. Auto-creates an internal prompt for the agent.

prompt

object

Reference to an existing prompt (alternative to prompt_content).

Show properties

prompt_name

string

required

Name of the existing prompt.

prompt_version

integer

Specific version (omit for latest).

first_message_prompt

string

Agent’s greeting message displayed when a chat session starts.

tools

object

Configure agent tools. Each tool can be true (enable), false (disable), or an object with configuration.Available tools: end_call, transfer_call, schedule_call, set_language, background_audio, user_idle.

Widget configuration for chat interface customization.

Response

Returns the complete agent object with all configurations, id, and timestamps.

Authorizations

X-API-Key

string

header

required

API key for authentication. Get your API key from the eigi.ai Dashboard under Settings â†’ API Keys.

Body

application/json

agent_name

string

required

Agent name (1-100 characters)

Required string length: 1 - 100

Example:

"Customer Support Agent"

agent_type

enum<string>

required

Agent type

Available options:

INBOUND,

OUTBOUND

stt

object

required

Show child attributes

llm

object

required

Show child attributes

tts

object

required

Show child attributes

agent_description

string

Agent description (max 500 characters)

Maximum string length: 500

agent_category

enum<string>

default:other

Agent category

Available options:

Customer Service,

Sales,

Scheduling,

Research,

Healthcare,

Customer Success,

Education,

Finance,

HR,

Legal,

Productivity,

Creative,

IT/DevOps,

E-commerce,

Entertainment,

Travel,

Wellness,

Anime,

Cartoon,

Gaming,

Lifestyle,

other

agent_tips

string[]

Usage tips for the agent

agent_mobile_number

string[]

Mobile numbers associated with the agent

prompt_content

string

Inline prompt content — auto-creates an internal prompt for the agent

prompt

object

Reference to an existing prompt (alternative to prompt_content)

Show child attributes

first_message_prompt

string

Agent's greeting message shown when chat starts

tools

object

Configure agent tools. Each tool can be true (enable), false (disable), or an object with configuration.

Show child attributes

Widget configuration for chat interface customization

Show child attributes

Response

Agent created successfully

string

Agent ID

agent_name

string

Agent name

agent_description

string

Agent description

agent_type

enum<string>

Agent type

Available options:

INBOUND,

OUTBOUND

agent_category

string

Agent category

agent_tips

string[]

Usage tips

agent_mobile_number

string[]

Associated mobile numbers

stt

object

STT configuration

llm

object

LLM configuration

tts

object

TTS configuration

sts

object

STS configuration (if set)

prompt

object

Prompt reference

Show child attributes

first_message_prompt

string

Agent's greeting message

dynamic_variables

string[]

Dynamic variables in the prompt

tools

object

Configured tools

Widget configuration

MediaFiles

object[]

Media files associated with the agent

Show child attributes

created_at

string<date-time>

Creation timestamp

updated_at

string<date-time>

Last update timestamp

Delete Prompt List Agents

Documentation Index

​Overview

​Prompt Configuration

​Provider Restrictions (Public API)

​Authentication

​Request Body

​Response

Authorizations

Body

Response

Overview

Prompt Configuration

Provider Restrictions (Public API)

Authentication

Request Body

Response