Schedules

Operations for creating and managing scheduled agents

List scheduled agents

get

Retrieve all scheduled agents accessible to the authenticated user. Results are sorted alphabetically by name.

Authorizations

bearerAuth

AuthorizationstringRequired

Authentication via personal API key or service account credentials.

Responses

200

List of scheduled agents

application/json

Response containing all scheduled agents accessible to the authenticated user, sorted alphabetically by name.

401

Authentication required

application/json

500

Internal server error

application/json

get

/agent/schedules

HTTPcURLJavaScriptPython

GET /api/v1/agent/schedules HTTP/1.1
Host: app.warp.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "schedules": [
    {
      "id": "text",
      "name": "text",
      "cron_schedule": "text",
      "enabled": true,
      "prompt": "text",
      "last_spawn_error": "text",
      "agent_config": {
        "name": "text",
        "model_id": "text",
        "base_prompt": "text",
        "environment_id": "text",
        "skill_spec": "text",
        "mcp_servers": {
          "ANY_ADDITIONAL_PROPERTY": {
            "warp_id": "text",
            "command": "text",
            "args": [
              "text"
            ],
            "url": "https://example.com",
            "env": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "headers": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            }
          }
        },
        "computer_use_enabled": true,
        "worker_host": "text"
      },
      "environment": {
        "name": "text",
        "description": "text",
        "docker_image": "text",
        "github_repos": [
          {
            "owner": "text",
            "repo": "text"
          }
        ],
        "setup_commands": [
          "text"
        ]
      },
      "created_at": "2026-03-20T20:36:47.135Z",
      "updated_at": "2026-03-20T20:36:47.135Z",
      "created_by": {
        "type": "user",
        "uid": "text",
        "display_name": "text",
        "email": "text",
        "photo_url": "https://example.com"
      },
      "updated_by": {
        "type": "user",
        "uid": "text",
        "display_name": "text",
        "email": "text",
        "photo_url": "https://example.com"
      },
      "history": {
        "last_ran": "2026-03-20T20:36:47.135Z",
        "next_run": "2026-03-20T20:36:47.135Z"
      },
      "scope": {
        "type": "User",
        "uid": "text"
      }
    }
  ]
}

Create a scheduled agent

post

Create a new scheduled agent that runs on a cron schedule. The agent will be triggered automatically based on the cron expression.

Authorizations

bearerAuth

AuthorizationstringRequired

Authentication via personal API key or service account credentials.

Body

application/json

Request body for creating a new scheduled agent. Either prompt or agent_config.skill_spec is required.

namestringRequired

Human-readable name for the schedule

cron_schedulestringRequired

Cron expression defining when the agent runs (e.g., "0 9 * * *" for daily at 9am UTC)

promptstringOptional

The prompt/instruction for the agent to execute. Required unless agent_config.skill_spec is provided.

enabledbooleanOptional

Whether the schedule should be active immediately

Default: true

teambooleanOptional

Whether to create a team-owned schedule. Defaults to true for users on a single team.

Responses

201

Scheduled agent created successfully

application/json

400

Invalid request (missing required fields, invalid cron expression)

application/json

401

Authentication required

application/json

403

No permission or feature not available

application/json

post

/agent/schedules

HTTPcURLJavaScriptPython

POST /api/v1/agent/schedules HTTP/1.1
Host: app.warp.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 129

{
  "name": "Daily Code Review",
  "cron_schedule": "0 9 * * *",
  "prompt": "Review open pull requests and provide feedback",
  "enabled": true
}

Simple daily scheduleWith agent config

{
  "id": "text",
  "name": "text",
  "cron_schedule": "text",
  "enabled": true,
  "prompt": "text",
  "last_spawn_error": "text",
  "agent_config": {
    "name": "text",
    "model_id": "text",
    "base_prompt": "text",
    "environment_id": "text",
    "skill_spec": "text",
    "mcp_servers": {
      "ANY_ADDITIONAL_PROPERTY": {
        "warp_id": "text",
        "command": "text",
        "args": [
          "text"
        ],
        "url": "https://example.com",
        "env": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    },
    "computer_use_enabled": true,
    "worker_host": "text"
  },
  "environment": {
    "name": "text",
    "description": "text",
    "docker_image": "text",
    "github_repos": [
      {
        "owner": "text",
        "repo": "text"
      }
    ],
    "setup_commands": [
      "text"
    ]
  },
  "created_at": "2026-03-20T20:36:47.135Z",
  "updated_at": "2026-03-20T20:36:47.135Z",
  "created_by": {
    "type": "user",
    "uid": "text",
    "display_name": "text",
    "email": "text",
    "photo_url": "https://example.com"
  },
  "updated_by": {
    "type": "user",
    "uid": "text",
    "display_name": "text",
    "email": "text",
    "photo_url": "https://example.com"
  },
  "history": {
    "last_ran": "2026-03-20T20:36:47.135Z",
    "next_run": "2026-03-20T20:36:47.135Z"
  },
  "scope": {
    "type": "User",
    "uid": "text"
  }
}

Get scheduled agent details

get

Retrieve detailed information about a specific scheduled agent, including its configuration, history, and next scheduled run time.

Authorizations

bearerAuth

AuthorizationstringRequired

Authentication via personal API key or service account credentials.

Path parameters

scheduleIdstringRequired

The unique identifier of the scheduled agent

Responses

200

Scheduled agent details

application/json

idstringRequired

Unique identifier for the scheduled agent

namestringRequired

Human-readable name for the schedule

cron_schedulestringRequired

Cron expression defining when the agent runs (e.g., "0 9 * * *" for daily at 9am UTC)

enabledbooleanRequired

Whether the schedule is currently active

promptstringRequired

The prompt/instruction for the agent to execute

last_spawn_errorstring · nullableOptional

Error message from the last failed spawn attempt, if any

created_atstring · date-timeRequired

Timestamp when the schedule was created (RFC3339)

updated_atstring · date-timeRequired

Timestamp when the schedule was last updated (RFC3339)

400

Missing schedule ID

application/json

401

Authentication required

application/json

403

No permission to access schedule

application/json

404

Schedule not found

application/json

get

/agent/schedules/{scheduleId}

HTTPcURLJavaScriptPython

GET /api/v1/agent/schedules/{scheduleId} HTTP/1.1
Host: app.warp.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text",
  "cron_schedule": "text",
  "enabled": true,
  "prompt": "text",
  "last_spawn_error": "text",
  "agent_config": {
    "name": "text",
    "model_id": "text",
    "base_prompt": "text",
    "environment_id": "text",
    "skill_spec": "text",
    "mcp_servers": {
      "ANY_ADDITIONAL_PROPERTY": {
        "warp_id": "text",
        "command": "text",
        "args": [
          "text"
        ],
        "url": "https://example.com",
        "env": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    },
    "computer_use_enabled": true,
    "worker_host": "text"
  },
  "environment": {
    "name": "text",
    "description": "text",
    "docker_image": "text",
    "github_repos": [
      {
        "owner": "text",
        "repo": "text"
      }
    ],
    "setup_commands": [
      "text"
    ]
  },
  "created_at": "2026-03-20T20:36:47.135Z",
  "updated_at": "2026-03-20T20:36:47.135Z",
  "created_by": {
    "type": "user",
    "uid": "text",
    "display_name": "text",
    "email": "text",
    "photo_url": "https://example.com"
  },
  "updated_by": {
    "type": "user",
    "uid": "text",
    "display_name": "text",
    "email": "text",
    "photo_url": "https://example.com"
  },
  "history": {
    "last_ran": "2026-03-20T20:36:47.135Z",
    "next_run": "2026-03-20T20:36:47.135Z"
  },
  "scope": {
    "type": "User",
    "uid": "text"
  }
}

Update a scheduled agent

put

Update an existing scheduled agent's configuration. All fields except agent_config are required.

Authorizations

bearerAuth

AuthorizationstringRequired

Authentication via personal API key or service account credentials.

Path parameters

scheduleIdstringRequired

The unique identifier of the scheduled agent

Body

application/json

Request body for updating a scheduled agent. Either prompt or agent_config.skill_spec is required.

namestringRequired

Human-readable name for the schedule

cron_schedulestringRequired

Cron expression defining when the agent runs

promptstringOptional

The prompt/instruction for the agent to execute. Required unless agent_config.skill_spec is provided.

enabledbooleanRequired

Whether the schedule should be active

Responses

200

Scheduled agent updated successfully

application/json

idstringRequired

Unique identifier for the scheduled agent

namestringRequired

Human-readable name for the schedule

cron_schedulestringRequired

Cron expression defining when the agent runs (e.g., "0 9 * * *" for daily at 9am UTC)

enabledbooleanRequired

Whether the schedule is currently active

promptstringRequired

The prompt/instruction for the agent to execute

last_spawn_errorstring · nullableOptional

Error message from the last failed spawn attempt, if any

created_atstring · date-timeRequired

Timestamp when the schedule was created (RFC3339)

updated_atstring · date-timeRequired

Timestamp when the schedule was last updated (RFC3339)

400

Invalid request

application/json

401

Authentication required

application/json

403

No permission to update schedule

application/json

404

Schedule not found

application/json

put

/agent/schedules/{scheduleId}

HTTPcURLJavaScriptPython

PUT /api/v1/agent/schedules/{scheduleId} HTTP/1.1
Host: app.warp.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 440

{
  "name": "text",
  "cron_schedule": "text",
  "prompt": "text",
  "enabled": true,
  "agent_config": {
    "name": "text",
    "model_id": "text",
    "base_prompt": "text",
    "environment_id": "text",
    "skill_spec": "text",
    "mcp_servers": {
      "ANY_ADDITIONAL_PROPERTY": {
        "warp_id": "text",
        "command": "text",
        "args": [
          "text"
        ],
        "url": "https://example.com",
        "env": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    },
    "computer_use_enabled": true,
    "worker_host": "text"
  }
}

{
  "id": "text",
  "name": "text",
  "cron_schedule": "text",
  "enabled": true,
  "prompt": "text",
  "last_spawn_error": "text",
  "agent_config": {
    "name": "text",
    "model_id": "text",
    "base_prompt": "text",
    "environment_id": "text",
    "skill_spec": "text",
    "mcp_servers": {
      "ANY_ADDITIONAL_PROPERTY": {
        "warp_id": "text",
        "command": "text",
        "args": [
          "text"
        ],
        "url": "https://example.com",
        "env": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    },
    "computer_use_enabled": true,
    "worker_host": "text"
  },
  "environment": {
    "name": "text",
    "description": "text",
    "docker_image": "text",
    "github_repos": [
      {
        "owner": "text",
        "repo": "text"
      }
    ],
    "setup_commands": [
      "text"
    ]
  },
  "created_at": "2026-03-20T20:36:47.135Z",
  "updated_at": "2026-03-20T20:36:47.135Z",
  "created_by": {
    "type": "user",
    "uid": "text",
    "display_name": "text",
    "email": "text",
    "photo_url": "https://example.com"
  },
  "updated_by": {
    "type": "user",
    "uid": "text",
    "display_name": "text",
    "email": "text",
    "photo_url": "https://example.com"
  },
  "history": {
    "last_ran": "2026-03-20T20:36:47.135Z",
    "next_run": "2026-03-20T20:36:47.135Z"
  },
  "scope": {
    "type": "User",
    "uid": "text"
  }
}

Delete a scheduled agent

delete

Delete a scheduled agent. This will stop all future scheduled runs.

Authorizations

bearerAuth

AuthorizationstringRequired

Authentication via personal API key or service account credentials.

Path parameters

scheduleIdstringRequired

The unique identifier of the scheduled agent

Responses

200

Scheduled agent deleted successfully

application/json

Confirmation response returned after a scheduled agent is successfully deleted.

successbooleanRequired

Whether the deletion was successful

401

Authentication required

application/json

403

No permission to delete schedule

application/json

404

Schedule not found

application/json

500

Internal server error

application/json

delete

/agent/schedules/{scheduleId}

HTTPcURLJavaScriptPython

DELETE /api/v1/agent/schedules/{scheduleId} HTTP/1.1
Host: app.warp.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true
}

Pause a scheduled agent

post

Pause a scheduled agent. The agent will not run until resumed. This sets the enabled flag to false.

Authorizations

bearerAuth

AuthorizationstringRequired

Authentication via personal API key or service account credentials.

Path parameters

scheduleIdstringRequired

The unique identifier of the scheduled agent

Responses

200

Scheduled agent paused successfully

application/json

idstringRequired

Unique identifier for the scheduled agent

namestringRequired

Human-readable name for the schedule

cron_schedulestringRequired

Cron expression defining when the agent runs (e.g., "0 9 * * *" for daily at 9am UTC)

enabledbooleanRequired

Whether the schedule is currently active

promptstringRequired

The prompt/instruction for the agent to execute

last_spawn_errorstring · nullableOptional

Error message from the last failed spawn attempt, if any

created_atstring · date-timeRequired

Timestamp when the schedule was created (RFC3339)

updated_atstring · date-timeRequired

Timestamp when the schedule was last updated (RFC3339)

401

Authentication required

application/json

403

No permission to pause schedule

application/json

404

Schedule not found

application/json

500

Internal server error

application/json

post

/agent/schedules/{scheduleId}/pause

HTTPcURLJavaScriptPython

POST /api/v1/agent/schedules/{scheduleId}/pause HTTP/1.1
Host: app.warp.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text",
  "cron_schedule": "text",
  "enabled": true,
  "prompt": "text",
  "last_spawn_error": "text",
  "agent_config": {
    "name": "text",
    "model_id": "text",
    "base_prompt": "text",
    "environment_id": "text",
    "skill_spec": "text",
    "mcp_servers": {
      "ANY_ADDITIONAL_PROPERTY": {
        "warp_id": "text",
        "command": "text",
        "args": [
          "text"
        ],
        "url": "https://example.com",
        "env": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    },
    "computer_use_enabled": true,
    "worker_host": "text"
  },
  "environment": {
    "name": "text",
    "description": "text",
    "docker_image": "text",
    "github_repos": [
      {
        "owner": "text",
        "repo": "text"
      }
    ],
    "setup_commands": [
      "text"
    ]
  },
  "created_at": "2026-03-20T20:36:47.135Z",
  "updated_at": "2026-03-20T20:36:47.135Z",
  "created_by": {
    "type": "user",
    "uid": "text",
    "display_name": "text",
    "email": "text",
    "photo_url": "https://example.com"
  },
  "updated_by": {
    "type": "user",
    "uid": "text",
    "display_name": "text",
    "email": "text",
    "photo_url": "https://example.com"
  },
  "history": {
    "last_ran": "2026-03-20T20:36:47.135Z",
    "next_run": "2026-03-20T20:36:47.135Z"
  },
  "scope": {
    "type": "User",
    "uid": "text"
  }
}

Resume a scheduled agent

post

Resume a paused scheduled agent. The agent will start running according to its cron schedule. This sets the enabled flag to true.

Authorizations

bearerAuth

AuthorizationstringRequired

Authentication via personal API key or service account credentials.

Path parameters

scheduleIdstringRequired

The unique identifier of the scheduled agent

Responses

200

Scheduled agent resumed successfully

application/json

idstringRequired

Unique identifier for the scheduled agent

namestringRequired

Human-readable name for the schedule

cron_schedulestringRequired

Cron expression defining when the agent runs (e.g., "0 9 * * *" for daily at 9am UTC)

enabledbooleanRequired

Whether the schedule is currently active

promptstringRequired

The prompt/instruction for the agent to execute

last_spawn_errorstring · nullableOptional

Error message from the last failed spawn attempt, if any

created_atstring · date-timeRequired

Timestamp when the schedule was created (RFC3339)

updated_atstring · date-timeRequired

Timestamp when the schedule was last updated (RFC3339)

401

Authentication required

application/json

403

No permission to resume schedule

application/json

404

Schedule not found

application/json

500

Internal server error

application/json

post

/agent/schedules/{scheduleId}/resume

HTTPcURLJavaScriptPython

POST /api/v1/agent/schedules/{scheduleId}/resume HTTP/1.1
Host: app.warp.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text",
  "cron_schedule": "text",
  "enabled": true,
  "prompt": "text",
  "last_spawn_error": "text",
  "agent_config": {
    "name": "text",
    "model_id": "text",
    "base_prompt": "text",
    "environment_id": "text",
    "skill_spec": "text",
    "mcp_servers": {
      "ANY_ADDITIONAL_PROPERTY": {
        "warp_id": "text",
        "command": "text",
        "args": [
          "text"
        ],
        "url": "https://example.com",
        "env": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    },
    "computer_use_enabled": true,
    "worker_host": "text"
  },
  "environment": {
    "name": "text",
    "description": "text",
    "docker_image": "text",
    "github_repos": [
      {
        "owner": "text",
        "repo": "text"
      }
    ],
    "setup_commands": [
      "text"
    ]
  },
  "created_at": "2026-03-20T20:36:47.135Z",
  "updated_at": "2026-03-20T20:36:47.135Z",
  "created_by": {
    "type": "user",
    "uid": "text",
    "display_name": "text",
    "email": "text",
    "photo_url": "https://example.com"
  },
  "updated_by": {
    "type": "user",
    "uid": "text",
    "display_name": "text",
    "email": "text",
    "photo_url": "https://example.com"
  },
  "history": {
    "last_ran": "2026-03-20T20:36:47.135Z",
    "next_run": "2026-03-20T20:36:47.135Z"
  },
  "scope": {
    "type": "User",
    "uid": "text"
  }
}