Skip to main content
POST
/
api
/
v1
/
schedules
Create schedule
curl --request POST \
  --url https://neo.api.projectdiscovery.io/api/v1/schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "task_message": "<string>",
  "custom_weekdays": [
    3
  ],
  "direct_agent_id": "<string>",
  "file_keys": [
    "<string>"
  ],
  "metadata": {},
  "name": "<string>",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "run_at": "<string>",
  "schedule_type": "recurring",
  "secrets": [
    "<string>"
  ],
  "source_task_id": "<string>",
  "start_time": "<string>"
}
'
{
  "schedule": {
    "created_at": "2023-11-07T05:31:56Z",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "file_count": 123,
    "frequency_description": "<string>",
    "has_files": true,
    "name": "<string>",
    "next_execution_at": "2023-11-07T05:31:56Z",
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "scan_frequency": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

JWT authentication token

Body

application/json
​
task_message
string
required

The task message to execute

Minimum string length: 1
​
custom_weekdays
integer[]

For custom frequency - array of weekdays (0=Sunday, 6=Saturday)

Required range: 0 <= x <= 6
​
direct_agent_id
string
​
file_keys
string[]

Optional file references

​
llm_model
enum<string>

LLM model identifier. "auto" defers model selection to the agent, which picks per-request based on task complexity, cost, and security context.

Available options:
auto,
opus-4.8,
opus-4.7,
opus-4.6,
sonnet-4.6,
haiku-4.5,
gpt-5.5-high,
gpt-5.4-xhigh,
gpt-5.4-high,
gpt-5.3-codex-high,
gemini-3-pro,
gemini-3-flash,
grok-4.3-high,
grok-4.3-fast,
kimi-k2.6,
glm-5,
glm-5.1,
deepseek-v4-pro-high
​
metadata
object

Optional metadata for delivery configuration (e.g., Slack channel info for posting results)

​
name
string

Human-readable schedule name

Maximum string length: 256
​
project_id
string<uuid>

Optional project ID to create a project-scoped schedule (requires project membership)

​
reporting_mode
enum<string>

Output reporting mode - 'full' (default) returns all data, 'changes_only' generates a diff report comparing current results with the previous execution

Available options:
full,
changes_only
​
run_at
string

For one_time schedules - relative ("5m", "1h", "2d") or absolute ("14:30", "3:00PM") time

​
scan_frequency
enum<string>

Required for recurring schedules

Available options:
daily,
weekly,
monthly,
custom
​
schedule_type
enum<string>
default:recurring
Available options:
recurring,
one_time
​
secrets
string[]

Optional secret names to expose to each scheduled execution

​
selected_visibility_type
enum<string>
Available options:
public,
private,
team
​
source_task_id
string

The source task/chat ID that this schedule was created from (if any)

​
start_time
string

Start time in HH:MM format (24h)

Response

Schedule created

​
schedule
object
required