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

create agentflow

POST
api.wexa.ai/agentflow/
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '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-23 12:17:09
Previous
get agentflow by id
Next
Add skilled agent to agentflow
Built with