Skip to main content
POST
Create ai agent

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Body for creating an AI Reply Agent or AI Sales Agent. To create a reply agent, provide a "payload" field. To create an AI Sales Agent, provide "type" (website or pitch_deck) and "input", or set "memory_from_workspace" to true.

Body for creating an AI Reply Agent or AI Sales Agent. To create a reply agent, provide a "payload" field. To create an AI Sales Agent, provide "type" (website or pitch_deck) and "input", or set "memory_from_workspace" to true.

name
string
required

Name of the agent

Example:

"My AI Agent"

payload
object

Reply agent (Inbox Manager) payload

type
any

Agent type: number (1 = Reply Agent) or SDR type string ("website" or "pitch_deck").

input
string

URL for website scraping or text content for pitch deck extraction. Required for AI Sales Agent creation unless memory_from_workspace is true.

Example:

"https://example.com"

status
enum<number>

Optional initial status of the agent.

Available options:
-1,
0,
1
Example:

1

memory_from_workspace
boolean

When true, skips the initial scrape and copies memory from an existing AI Sales Agent in the workspace (AI Sales Agent creation only).

Example:

true

description
string

Optional description for the AI Sales Agent.

config
object

AI Sales Agent configuration object.

master_lead_list_id
string<uuid>

Master lead list ID for the AI Sales Agent.

initial_scrape_ready
boolean

Whether the initial scrape is ready (AI Sales Agent only).

Example:

false

is_duplicate
boolean

When true, duplicates an existing AI Sales Agent in this workspace. Must be sent together with source_ai_sdr_id. Other duplicate-only fields are not accepted via the public API.

Example:

true

source_ai_sdr_id
string<uuid>

Required when is_duplicate is true: the id of the AI Sales Agent to copy from. Must exist in the current workspace.

agent_type
enum<number>

Agent type code for SDR-like agents. Defaults to SDR Agent (2) when omitted.

Available options:
2,
4,
7,
8,
9,
10

Response

The created AI agent or AI Sales Agent

An AI agent

id
string<uuid>
required
read-only

Unique identifier for the AI agent

Example:

"01a0206f-ab5d-7a94-b390-0e72d746d00a"

organization_id
string<uuid>
required
read-only

Organization ID

Example:

"01a0206f-ab5d-7a94-b390-0e739ce03f39"

name
string
required

Name of the AI Agent

Example:

"Test AI Agent"

payload
object
required

Lead Finder Agent payload

timestamp_created
string
required
read-only

Timestamp when the AI agent was created

Example:

"2026-08-20T18:29:44.413Z"

timestamp_updated
string
required
read-only

Timestamp when the AI agent was updated

Example:

"2026-08-20T18:29:44.413Z"

status
enum<number>
required

Status of the AI Agent

Available options:
-1,
0,
1
Example:

1

type
null | enum<number>

Type of the AI Agent

Available options:
1,
2,
3,
4,
6,
7,
8,
9,
10
Example:

1

is_auto_created
null | boolean

Whether the AI agent was auto-created

Example:

false

created_by
null | string<uuid>
read-only

User ID who created the AI agent

Example:

"01a0206f-ab5d-7a94-b390-0e74994e2dba"

description
null | string
read-only

Description of the AI agent

Example:

"Optional agent description"