v2

OpenAPI 3.0.02026-08-051996591.2 MB

Agent Schedules

List agent schedules

Lists all schedules for the specified agent. Returns high-level information about each schedule, including execution status and next scheduled execution time.

get/v2/agents/{agent_key}/schedules

Path parameters

agent_keystring required

A unique key that identifies an agent.

Example:customer_support

The unique key of the agent to list schedules for.

Query parameters

limitinteger

The maximum number of schedules to return in the list.

page_keystring

The opaque cursor returned in metadata.page_key of the previous response. Omit it to fetch the first page.

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Response

List of agent schedules.

Example response

{
  "schedules": [
    {
      "key": "daily-report",
      "agent_key": "customer_support",
      "name": "Daily Summary Report",
      "description": "Generates a daily summary report of customer support activities",
      "message": [
        {
          "type": "text",
          "content": "Generate a summary of today's activities"
        }
      ],
      "schedule": {
        "type": "interval",
        "interval": "PT24H"
      },
      "enabled": true,
      "session_metadata": {
        "report_type": "daily",
        "format": "markdown"
      },
      "run_condition": "get('$.session.metadata.open_incidents') > 0",
      "max_executions_to_keep": 10,
      "stall_timeout_seconds": 1800,
      "last_execution_at": "2024-01-15T10:30:00Z",
      "created_at": "1970-01-01T00:00:00Z"
    }
  ],
  "metadata": {
    "page_key": "eyJvZmZzZXQiOjF9"
  }
}