Wexa AI
  1. Coworker schedules
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
      • 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
        GET
      • create coworker schedule
        POST
      • get schedule coworker by its id
        GET
      • update schedule by its id
        PATCH
      • delete schedule by its id
        DELETE
    • Analytics
      • Get analytics
    • Marketplace coworkers
      • hire a coworker
      • check marketplace coworker update
    • Project member
      • project_member
  1. Coworker schedules

create coworker schedule

POST
https://api.wexa.ai/schedule/coworker
Last modified:2025-04-25 12:31:59

Schedule an AI Coworker Task#

Use this endpoint to schedule a specific task for an AI Coworker in your Wexa.ai environment. Scheduling tasks allows you to automate actions at precise times, ensuring timely execution of workflows and enhancing operational efficiency.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.wexa.ai/schedule/coworker?projectID=67fdea40aac77be632954f13' \
--header 'x-api-key: {{x-api-key}}' \
--header 'Content-Type: application/json' \
--data-raw '{"coworker_id":"68067c49c517ff5238533ccf","goal":{"template":"say about abdul kalam","display_template":"[{\"type\":\"paragraph\",\"children\":[{\"text\":\"say about abdul kalam\"}]}]"},"schedule":1745322000.0
}'
Response Response Example
{
  "conclusion": null,
  "count": 0,
  "coworker_id": "68067c49c517ff5238533ccf",
  "created_at": 1745303421.154476,
  "created_by": "67fdea40aac77be632954f0e",
  "frequency": null,
  "goal": {
    "display_template": "[{\"type\":\"paragraph\",\"children\":[{\"text\":\"say about abdul kalam\"}]}]",
    "template": "say about abdul kalam"
  },
  "_id": "6807377dff5c4953f01709bc",
  "last_coworker_execution_id": null,
  "last_record_id": null,
  "limit": null,
  "projectID": "67fdea40aac77be632954f13",
  "schedule": 1745322000,
  "status": "active",
  "table": null,
  "type": "once",
  "updated_at": null,
  "task_id": "6807377cff5c4953f01709ba"
}

Request

Query Params
projectID
string 
required
Example:
67fdea40aac77be632954f13
Header Params
x-api-key
string 
required
Example:
{{x-api-key}}
Body Params application/json
coworker_id
string 
required
goal
object 
required
template
string 
required
display_template
string 
required
schedule
integer 
required
Examples

Responses

🟢201create coworker schedule
application/json
Body
conclusion
null 
required
count
integer 
required
coworker_id
string 
required
created_at
number 
required
created_by
string 
required
frequency
null 
required
goal
object 
required
display_template
string 
required
template
string 
required
_id
string 
required
last_coworker_execution_id
null 
required
last_record_id
null 
required
limit
null 
required
projectID
string 
required
schedule
integer 
required
status
string 
required
table
null 
required
type
string 
required
updated_at
null 
required
task_id
string 
required
Modified at 2025-04-25 12:31:59
Previous
get schedules
Next
get schedule coworker by its id