Create a scheduled task

Create a scheduled task: saved instructions that run as an agent on a schedule or on demand, optionally with Slack delivery.

POST/v1/projects/{projectId}/scheduled-tasks

Authorization

AuthorizationPersonal API key · headerrequired

Your personal API key from Settings > Personal API Keys, sent as Bearer <key>.

X-Organization-IdOrganization ID · headerrequired

The organization to act in. Copy it with Copy organization ID in the organization menu or the settings sidebar.

Path parameters

projectIdstringrequired

Request body

requiredapplication/json

namestringrequired

Scheduled task name.

matches \S

descriptionstring

Human-readable scheduled task description.

instructionsstring

Instructions the task follows on each run.

modestring

Execution mode. Use fast for quick runs or deep_research for more thorough runs.

Allowed:fastdeep_research

tool_permission_modestring

Write-tool approval mode. Use auto_require_permission to ask before write actions or always_accept to approve automatically.

Allowed:auto_require_permissionalways_accept

scheduleobject

When the task runs on its own. An omitted cadence keeps the one already stored, so a schedule can be turned back on without restating it.

Show properties

enabledbooleanrequired

cadenceobject | null

Show properties

Any of:

object

Any of:

object

modestring

frequencystringrequired

Allowed:dailyweekly

dayOfWeekinteger

min 0 · max 6

daysOfWeekinteger[]

hourintegerrequired

min 0 · max 23

minuteintegerrequired

min 0 · max 59

object

modestringrequired

everyintegerrequired

min 15 · max 1440

unitstringrequired

object

modestringrequired

everyintegerrequired

min 1 · max 24

unitstringrequired

object

modestringrequired

cronExpressionstringrequired

matches ^\S+\s+\S+\s+\S+\s+\S+\s+\S+$

null

null

timezonestring

IANA time zone the cadence is read in. Defaults to America/Los_Angeles. An update keeps the stored zone.

slack_channel_idsstring[]

Slack channel IDs the final output of each scheduled run is posted to. An empty list stops delivery. Requires the organization to have Slack connected.

Responses

200

Response for status 200

taskobjectrequired

Show properties

idstringrequired

kindstringrequired

Allowed:customsystem

is_defaultbooleanrequired

namestringrequired

descriptionstring | nullrequired

instructionsstring | nullrequired

modestringrequired

Allowed:fastdeep_research

tool_permission_modestringrequired

Allowed:auto_require_permissionalways_accept

created_bystring | nullrequired

created_atstringrequired

updated_atstringrequired

scheduleobject | nullrequired

Show properties

Any of:

object

enabledbooleanrequired

cadenceobject | nullrequired

Show properties

Any of:

object

Any of:

object

modestring

frequencystringrequired

Allowed:dailyweekly

dayOfWeekinteger

min 0 · max 6

daysOfWeekinteger[]

hourintegerrequired

min 0 · max 23

minuteintegerrequired

min 0 · max 59

object

modestringrequired

everyintegerrequired

min 15 · max 1440

unitstringrequired

object

modestringrequired

everyintegerrequired

min 1 · max 24

unitstringrequired

object

modestringrequired

cronExpressionstringrequired

matches ^\S+\s+\S+\s+\S+\s+\S+\s+\S+$

null

null

timezonestringrequired

sync_errorstring | nullrequired

null

null

slack_channel_idsstring[]required

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Personal API keyOrganization IDRemember on this deviceInclude my values in samples

Parameters

projectIdpath*

Bodyapplication/json

Request body

Request

curl -X POST 'https://api.judgmentlabs.ai/v1/projects/YOUR_PROJECT_ID/scheduled-tasks' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'X-Organization-Id: YOUR_ORGANIZATION_ID' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "description": "string",
  "instructions": "string",
  "mode": "fast",
  "tool_permission_mode": "auto_require_permission",
  "schedule": {
    "enabled": true,
    "cadence": {
      "mode": "calendar",
      "frequency": "daily",
      "dayOfWeek": 0,
      "daysOfWeek": [
        0
      ],
      "hour": 0,
      "minute": 0
    },
    "timezone": "string"
  },
  "slack_channel_ids": [
    "string"
  ]
}'

const response = await fetch("https://api.judgmentlabs.ai/v1/projects/YOUR_PROJECT_ID/scheduled-tasks", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "X-Organization-Id": "YOUR_ORGANIZATION_ID",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\",\n  \"description\": \"string\",\n  \"instructions\": \"string\",\n  \"mode\": \"fast\",\n  \"tool_permission_mode\": \"auto_require_permission\",\n  \"schedule\": {\n    \"enabled\": true,\n    \"cadence\": {\n      \"mode\": \"calendar\",\n      \"frequency\": \"daily\",\n      \"dayOfWeek\": 0,\n      \"daysOfWeek\": [\n        0\n      ],\n      \"hour\": 0,\n      \"minute\": 0\n    },\n    \"timezone\": \"string\"\n  },\n  \"slack_channel_ids\": [\n    \"string\"\n  ]\n}"
});

import requests

response = requests.post(
    "https://api.judgmentlabs.ai/v1/projects/YOUR_PROJECT_ID/scheduled-tasks",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "X-Organization-Id": "YOUR_ORGANIZATION_ID",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"description\": \"string\",\n  \"instructions\": \"string\",\n  \"mode\": \"fast\",\n  \"tool_permission_mode\": \"auto_require_permission\",\n  \"schedule\": {\n    \"enabled\": true,\n    \"cadence\": {\n      \"mode\": \"calendar\",\n      \"frequency\": \"daily\",\n      \"dayOfWeek\": 0,\n      \"daysOfWeek\": [\n        0\n      ],\n      \"hour\": 0,\n      \"minute\": 0\n    },\n    \"timezone\": \"string\"\n  },\n  \"slack_channel_ids\": [\n    \"string\"\n  ]\n}",
)

Response

{
  "task": {
    "id": "string",
    "kind": "custom",
    "is_default": true,
    "name": "string",
    "description": "string",
    "instructions": "string",
    "mode": "fast",
    "tool_permission_mode": "auto_require_permission",
    "created_by": "string",
    "created_at": "string",
    "updated_at": "string",
    "schedule": {
      "enabled": true,
      "cadence": {
        "mode": "calendar",
        "frequency": "daily",
        "dayOfWeek": 0,
        "daysOfWeek": [
          0
        ],
        "hour": 0,
        "minute": 0
      },
      "timezone": "string",
      "sync_error": "string"
    },
    "slack_channel_ids": [
      "string"
    ]
  }
}