Wexa AI
  1. Executeflow
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
      • get agentflows
      • Get agentflow by projectId and UserId
      • get agentflow by id
      • Add skilled agent to agentflow
      • Update skilled agent
    • 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
        POST
      • get executions
        GET
      • execute agentflow
        POST
      • pause executeflow
        POST
      • resume execution
        POST
      • cancel executeflow
        POST
      • get execution by execution id
        GET
      • get execution details for monitoring
        GET
    • 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. Executeflow

create executeflow

POST
https://api.wexa.ai/execute_flow
Last modified:2025-04-25 09:28:42

Execute AgentFlow#

Initiate the execution of a specified AgentFlow by providing its unique agentflow_id along with relevant execution parameters. This endpoint triggers the defined sequence of AI agents (Coworkers) within the AgentFlow to perform their tasks based on the provided goal and input variables. It's essential for automating workflows and ensuring that the AI agents operate in alignment with your organization's objectives.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.wexa.ai/execute_flow?projectID=67fdea40aac77be632954f13' \
--header 'x-api-key: {{x-api-key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "agentflow_id": "67fdea9b68df1c3e9580a549",
    "executed_by": "67fdea40aac77be632954f0e",
    "goal": "run",
    "input_variables": {},
    "projectID": "67fdea40aac77be632954f13"
}'
Response Response Example
{
  "agentflow_id": "67fdea9b68df1c3e9580a549",
  "files": [],
  "goal": "run",
  "schedule": null,
  "start_from_agent_id": null,
  "input_variables": {},
  "task_id": "6805f401064a778a5f18f846",
  "parent_execution_id": null,
  "agentflow": {
    "agentflow_id": "67fdea9b68df1c3e9580a549",
    "agents": [
      {
        "_id": "67fdea9b68df1c3e9580a54a",
        "llm": {
          "model": "azure/gpt-4o",
          "temperature": 0,
          "max_tokens": 10000
        },
        "role": "new platform",
        "role_description": "new platform",
        "title": "new platform",
        "agent_type": "skilled_agent",
        "next_agent": null
      }
    ],
    "image": "https://klotdev.blob.core.windows.net/coworkers/wexaworker13.png",
    "initialAgent": "67fdea9b68df1c3e9580a54a",
    "name": "new platform",
    "role": "new platform",
    "conclusion": null
  },
  "agents_output": [],
  "anomaly_detected": null,
  "conclusion": null,
  "created_at": 1745220609.00188,
  "end_time": null,
  "executed_by": {
    "_id": "67fdea40aac77be632954f0e",
    "metadata": null,
    "name": "nani799324",
    "type": "manual"
  },
  "execution_context": {},
  "execution_id": "8ffc2a03-5d38-4321-aae8-c9f32d7707fc",
  "goal_template": null,
  "_id": "6805f401064a778a5f18f845",
  "previews": {},
  "projectID": "67fdea40aac77be632954f13",
  "runtime_inputs": {},
  "status": "ready"
}

Request

Query Params
projectID
string 
required
Example:
67fdea40aac77be632954f13
Header Params
x-api-key
string 
required
Example:
{{x-api-key}}
Body Params application/json
agentflow_id
string 
required
executed_by
string 
required
goal
string 
required
input_variables
object 
required
projectID
string 
required
Examples

Responses

🟢201create executeflow
application/json
Body
agentflow_id
string 
required
files
array
required
goal
string 
required
schedule
null 
required
start_from_agent_id
null 
required
input_variables
object 
required
task_id
string 
required
parent_execution_id
null 
required
agentflow
object 
required
agentflow_id
string 
required
agents
array [object {7}] 
required
image
string 
required
initialAgent
string 
required
name
string 
required
role
string 
required
conclusion
null 
required
agents_output
array
required
anomaly_detected
null 
required
conclusion
null 
required
created_at
number 
required
end_time
null 
required
executed_by
object 
required
_id
string 
required
metadata
null 
required
name
string 
required
type
string 
required
execution_context
object 
required
execution_id
string 
required
goal_template
null 
required
_id
string 
required
previews
object 
required
projectID
string 
required
runtime_inputs
object 
required
status
string 
required
Modified at 2025-04-25 09:28:42
Previous
skills by name
Next
get executions