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

get agentflow by id

GET
https://api.wexa.ai/agentflow/{agentflow_id}
Last modified:2025-04-25 07:37:49

Get AgentFlow by ID#

This endpoint fetches comprehensive details of an AgentFlow specified by its unique id. The response includes information such as the AgentFlow's name, description, status, associated agents, their configurations, and assigned skills. This is essential for understanding and managing the automation workflows orchestrated by AI Coworkers in your organization.Retrieve detailed information about a specific AgentFlow using its unique identifier. This endpoint is essential for accessing the configuration and status of individual AgentFlows within your system.

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.wexa.ai/agentflow/' \
--header 'x-api-key;'
Response Response Example
{
  "_id": "67fdea9b68df1c3e9580a549",
  "name": "new platform",
  "image": "https://klotdev.blob.core.windows.net/coworkers/wexaworker13.png",
  "description": "new platform",
  "role": "new platform",
  "isActive": true,
  "projectID": "67fdea40aac77be632954f13",
  "organization_id": "67fdea40aac77be632954f0f",
  "initialAgent": "67fdea9b68df1c3e9580a54a",
  "created_at": 1744693915.589366,
  "updated_at": 1744693915.589376,
  "last_used": 1744693915.589377,
  "is_deleted": false,
  "is_cron_scheduled": false,
  "anomaly_detection": {
    "is_enabled": false,
    "instructions": ""
  },
  "marketplace_id": "67f73fa6f55e1a49293771eb",
  "agents": [
    {
      "_id": "67fdea9b68df1c3e9580a54a",
      "title": "new platform",
      "role": "new platform",
      "role_description": "new platform",
      "llm": {
        "model": "azure/gpt-4o",
        "temperature": 0,
        "max_tokens": 10000
      },
      "context": [],
      "has_knowledge_base": false,
      "prompt": {
        "template": "new platform",
        "variables": [],
        "display_template": "[{\"type\":\"paragraph\",\"children\":[{\"text\":\"new platform \"}]}]"
      },
      "triggers": [],
      "is_preview_mode_enabled": false,
      "pre_and_post_execution_input": null,
      "skills": [
        {
          "_id": "67fdea9a68df1c3e9580a547",
          "name": "Content creator - Content creation",
          "projectID": "67fdea40aac77be632954f13",
          "connector_id": "67fdea9968df1c3e9580a546",
          "description": "Creates content",
          "logo": "https://klotdev.blob.core.windows.net/wexa/92d70903-e331-445f-a34d-eebc93d4a520_429-4292382_generalicons-meeting-social-security-icon-png.png",
          "connector_name": "Content creator",
          "is_deleted": false,
          "user_id": null,
          "actions": [
            {
              "_id": "67fdea9a68df1c3e9580a548",
              "name": "Content creation",
              "endpoint": "/content_creator/generate",
              "sort": "generate",
              "category": "content_creator",
              "previous_action_id": null,
              "next_action_id": null,
              "is_terminal": true,
              "input_schema": {
                "fields": [
                  {
                    "field_id": "content",
                    "label": "content to generated",
                    "type": "object",
                    "required": true,
                    "description": "A JSON object with the data that is to be saved in the execution context and should be generated by an LLM. You can follow the instructions given in the task to generate appropriate json data. This is mandatory and you should provide the data in the format mentioned in the task. If nothing is mentioned, just interpret any relevant data and provide it in the JSON format."
                  }
                ]
              },
              "output_schema": {
                "fields": [
                  {
                    "field_id": "content",
                    "label": "Generated content",
                    "type": "object",
                    "required": true,
                    "description": "A JSON object representing the generated content based on the provided instructions."
                  }
                ]
              },
              "description": "This is a dummy connector that simply returns the input data as the output data.So when no other skills are available, this connector can be used."
            }
          ],
          "initial_action_id": "67fdea9a68df1c3e9580a548"
        }
      ],
      "agent_type": "skilled_agent",
      "next_agent": null
    }
  ],
  "goal_structure": null,
  "conclusion": null,
  "parent_agentflow_id": "1234",
  "agentflow_type": "master",
  "failover_goal": null
}

Request

Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************
Path Params
agentflow_id
string 
required

Responses

🟢200get agentflow by id
application/json
Body
_id
string 
required
name
string 
required
image
string 
required
description
string 
required
role
string 
required
isActive
boolean 
required
projectID
string 
required
organization_id
string 
required
initialAgent
string 
required
created_at
number 
required
updated_at
number 
required
last_used
number 
required
is_deleted
boolean 
required
is_cron_scheduled
boolean 
required
anomaly_detection
object 
required
is_enabled
boolean 
required
instructions
string 
required
marketplace_id
string 
required
agents
array [object {14}] 
required
_id
string 
optional
title
string 
optional
role
string 
optional
role_description
string 
optional
llm
object 
optional
context
array
optional
has_knowledge_base
boolean 
optional
prompt
object 
optional
triggers
array
optional
is_preview_mode_enabled
boolean 
optional
pre_and_post_execution_input
null 
optional
skills
array [object {11}] 
optional
agent_type
string 
optional
next_agent
null 
optional
goal_structure
null 
required
conclusion
null 
required
parent_agentflow_id
string 
required
agentflow_type
string 
required
failover_goal
null 
required
Modified at 2025-04-25 07:37:49
Previous
Get agentflow by projectId and UserId
Next
Add skilled agent to agentflow