Wexa AI
  1. Agentflows
Wexa AI
  • Wexa AI
  • Getting Started with Wexa AI
  • Use Cases and Workflows
  • API Reference
  • Tutorials
  • Troubleshooting Guide
  • API Endpoints
    • Project
      • create project
      • Get all projects
      • Get project
      • update project
      • Delete project
    • Agentflows
      • create agentflow
        POST
      • get agentflows
        GET
      • Get agentflow by projectId and UserId
        GET
      • get agentflow by id
        GET
      • Add skilled agent to agentflow
        POST
      • Update skilled agent
        POST
    • Connectors
      • get connectors by projectid
      • get connector by Id
      • Delete a connector
      • connector update status
      • get all available trigger actions
    • Skills
      • create skill
      • get skills
      • get skills by category'
      • get skills by id
      • skills by name
    • Executeflow
      • create executeflow
      • get executions
      • execute agentflow
      • pause executeflow
      • resume execution
      • cancel executeflow
      • get execution by execution id
      • get execution details for monitoring
    • Customer
      • get customer
      • Get credit history
    • Actions
      • create action
      • get action
    • Files
      • upload files
      • get files by fileid
      • get connector by fileid
      • get files by connector_id
    • Inbox
      • get inbox
    • Tags
      • tags
    • Tasks
      • get tasks
      • get task by id
      • Pause running task
      • resume task
      • Stop task
    • Tables
      • create table
      • create database
      • get tables
      • get records list
      • get table names
      • delete record
      • delete a column
    • Dashboard
      • get dashboard
      • refresh dashboard
      • delete component in dashboard
    • Settings
      • get settings
    • Marketplace
      • get all connectors
      • get marketplace coworkers
      • get marketplace coworker by id
    • Coworker schedules
      • get schedules
      • create coworker schedule
      • get schedule coworker by its id
      • update schedule by its id
      • delete schedule by its id
    • Analytics
      • Get analytics
    • Marketplace coworkers
      • hire a coworker
      • check marketplace coworker update
    • Project member
      • project_member
  1. Agentflows

create agentflow

POST
https://api.wexa.ai/agentflow/
Last modified:2025-04-25 08:48:44

Create AgentFlow#

Create a new AgentFlow within your organization. An AgentFlow in Wexa.ai represents a structured workflow comprising AI agents (Coworkers) equipped with specific skills to automate tasks and processes. This endpoint allows you to define the AgentFlow's configuration, including its name, description, associated agents, and operational parameters, enabling the orchestration of complex automation workflows tailored to your organization's needs.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.wexa.ai/agentflow/?projectID=67fdea40aac77be632954f13' \
--header 'x-api-key: {{x-api-key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "content creator testing",
    "description": "content creator testing",
    "role": "content creator testing",
    "projectID": "67fdea40aac77be632954f13"
}'
Response Response Example
{
  "_id": "68075a61ff5c4953f0170a10",
  "name": "content creator testing",
  "description": "content creator testing",
  "role": "content creator testing",
  "projectID": "67fdea40aac77be632954f13",
  "image": "https://klotdev.blob.core.windows.net/coworkers/process-flow-wexa-10.png",
  "agentflow_type": "master",
  "parent_agentflow_id": null,
  "failover_goal": null,
  "created_at": 1745312352.995075,
  "updated_at": 1745312352.995084,
  "last_used": 1745312352.995086,
  "isActive": true,
  "is_deleted": false,
  "default_goal": "",
  "is_cron_scheduled": false,
  "organization_id": "67fdea40aac77be632954f0f",
  "cron_details": {
    "agentflow_id": "",
    "goal": {
      "template": "",
      "display_template": ""
    },
    "collection_name": null,
    "query": {},
    "projectID": "",
    "frequency": "",
    "limit": null,
    "query_limit": null,
    "executed_by": null,
    "filters": null,
    "count": null
  },
  "anomaly_detection": {
    "is_enabled": false,
    "instructions": ""
  },
  "agents": []
}

Request

Query Params
projectID
string 
required
Example:
67fdea40aac77be632954f13
Header Params
x-api-key
string 
required
Example:
{{x-api-key}}
Body Params application/json
name
string 
required
description
string 
required
role
string 
required
projectID
string 
required
Examples

Responses

🟢200create agentflow
application/json
Body
_id
string 
required
name
string 
required
description
string 
required
role
string 
required
projectID
string 
required
image
string 
required
agentflow_type
string 
required
parent_agentflow_id
null 
required
failover_goal
null 
required
created_at
number 
required
updated_at
number 
required
last_used
number 
required
isActive
boolean 
required
is_deleted
boolean 
required
default_goal
string 
required
is_cron_scheduled
boolean 
required
organization_id
string 
required
cron_details
object 
required
agentflow_id
string 
required
goal
object 
required
collection_name
null 
required
query
object 
required
projectID
string 
required
frequency
string 
required
limit
null 
required
query_limit
null 
required
executed_by
null 
required
filters
null 
required
count
null 
required
anomaly_detection
object 
required
is_enabled
boolean 
required
instructions
string 
required
agents
array
required
Modified at 2025-04-25 08:48:44
Previous
Delete project
Next
get agentflows