Scheduler API

Scheduler API is used to manage the schedules for agents. Use this API to create a new schedule using the CRON expression to start jobs automatically on pre-defined time or recurring.

Schedule the agent

This API will schedule the agent as per the given cron expression.

Endpoint:

Method: POST
URL: https://api.agenty.com/v2/scheduler/{{AGENT_ID}}

Headers:

Query params:

Body:

{
    "type": "cron",
    "expression": "5 1 0 12 1/1 ? *"
    "is_enabled": true
}

Responses:

Status: OK | Code: 200

{
    "status_code": 200,
    "message": "Scheduled successfully"
}

Delete the schedule

This API will remove the agent schedule permanently.

Endpoint:

Method: DELETE
URL: https://api.agenty.com/v2/scheduler/{{AGENT_ID}}

Headers:

Query params:

Responses:

Status: OK | Code: 200

{
    "status_code": 200,
    "message": "Scheduler deleted successfully"
}