Skip to main content
POST
/
v1
/
agents
Create agent
curl --request POST \
  --url https://api.meetecho.ai/api/v1/agents \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Appointment Reminder",
  "system_prompt": "You are {{agent_name}}, a friendly appointment reminder assistant for {{business_name}}. You are calling {{recipient_first_name}} to remind them about their upcoming appointment on {{appointment_date}} at {{appointment_time}}. Confirm they can make it, or collect details to reschedule.",
  "output_schema": {
    "type": "object",
    "required": [
      "confirmed",
      "rescheduling"
    ],
    "properties": {
      "confirmed": {
        "type": "boolean",
        "description": "Whether the customer confirmed their appointment"
      },
      "rescheduling": {
        "type": "boolean",
        "description": "Whether the customer wants to reschedule"
      },
      "preferred_date": {
        "type": "string",
        "description": "Preferred new date if rescheduling"
      },
      "preferred_time": {
        "type": "string",
        "description": "Preferred new time if rescheduling"
      }
    }
  }
}
'
{
  "id": "ddb8be3b-a426-4122-b877-a0cba363c89d",
  "created_at": "2026-03-18T17:43:46.714Z",
  "business_id": "97bfa642-d2cb-46d5-8de8-6d3553c83007",
  "name": "Appointment Reminder",
  "system_prompt": "You are {{agent_name}}, a friendly appointment reminder assistant for {{business_name}}. You are calling {{recipient_first_name}} to remind them about their upcoming appointment on {{appointment_date}} at {{appointment_time}}. Confirm they can make it, or collect details to reschedule.",
  "output_schema": {
    "type": "object",
    "required": [
      "confirmed",
      "rescheduling"
    ],
    "properties": {
      "confirmed": {
        "type": "boolean"
      },
      "rescheduling": {
        "type": "boolean"
      },
      "preferred_date": {
        "type": "string"
      },
      "preferred_time": {
        "type": "string"
      }
    }
  },
  "status": "active",
  "updated_at": "2026-03-18T17:43:46.714Z"
}

Authorizations

​
x-api-key
string
header
required

Echo API key — format: echo_<64 hex chars>. Returned once on signup.

Body

application/json
​
name
string
required
Example:

"Appointment Reminder"

​
system_prompt
string
required

Supports built-in variables: {{business_name}}, {{business_summary}}, {{recipient_name}}, {{recipient_first_name}}, {{message}}, {{context}}. Any additional {{key}} tokens are filled from the variables map on each notification.

Example:

"You are {{agent_name}}, a friendly appointment reminder assistant for {{business_name}}. You are calling {{recipient_first_name}} to remind them about their upcoming appointment on {{appointment_date}} at {{appointment_time}}. Confirm they can make it, or collect details to reschedule."

​
output_schema
object

JSON Schema for structured data extraction after the call. Omit for unstructured calls.

Example:
{
  "type": "object",
  "required": ["confirmed", "rescheduling"],
  "properties": {
    "confirmed": {
      "type": "boolean",
      "description": "Whether the customer confirmed their appointment"
    },
    "rescheduling": {
      "type": "boolean",
      "description": "Whether the customer wants to reschedule"
    },
    "preferred_date": {
      "type": "string",
      "description": "Preferred new date if rescheduling"
    },
    "preferred_time": {
      "type": "string",
      "description": "Preferred new time if rescheduling"
    }
  }
}

Response

201 - application/json

Agent created

​
id
string<uuid>
Example:

"ddb8be3b-a426-4122-b877-a0cba363c89d"

​
business_id
string<uuid>
Example:

"97bfa642-d2cb-46d5-8de8-6d3553c83007"

​
name
string
Example:

"Appointment Reminder"

​
system_prompt
string
Example:

"You are {{agent_name}}, a friendly appointment reminder assistant for {{business_name}}. You are calling {{recipient_first_name}} to remind them about their upcoming appointment on {{appointment_date}} at {{appointment_time}}. Confirm they can make it, or collect details to reschedule."

​
output_schema
object
Example:
{
  "type": "object",
  "required": ["confirmed", "rescheduling"],
  "properties": {
    "confirmed": { "type": "boolean" },
    "rescheduling": { "type": "boolean" },
    "preferred_date": { "type": "string" },
    "preferred_time": { "type": "string" }
  }
}
​
status
enum<string>
Available options:
active,
disabled
Example:

"active"

​
created_at
string<date-time>
Example:

"2026-03-18T17:43:46.714Z"

​
updated_at
string<date-time>
Example:

"2026-03-18T17:43:46.714Z"