> ## Documentation Index > Fetch the complete documentation index at: https://docs.neo.projectdiscovery.io/llms.txt > Use this file to discover all available pages before exploring further. # Create schedule > Create a new scheduled or one-time task. **Schedule Types:** - `recurring`: Repeating schedule (daily, weekly, monthly, or custom) - `one_time`: Single execution at specified time **For recurring schedules:** - `scan_frequency`: Required - one of daily, weekly, monthly, custom - `start_time`: Optional - HH:MM format for when to run (default: current time) - `custom_weekdays`: For custom - array of weekdays (0=Sunday, 6=Saturday) **For one-time schedules:** - `run_at`: Required - relative ("5m", "1h", "2d") or absolute ("14:30", "3:00PM") time ## OpenAPI ````yaml /openapi/neo.public.openapi.json post /api/v1/schedules openapi: 3.1.0 info: contact: name: ProjectDiscovery url: https://neo.projectdiscovery.io description: Neo API Server - Security agent orchestration platform license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 title: Neo API version: 1.0.0 servers: - description: Production url: https://neo.api.projectdiscovery.io - description: Development url: https://neo.api.dev.projectdiscovery.io - description: Local development url: http://localhost:8080 security: [] tags: - description: Task execution and management name: Tasks - description: Agent listing and management name: Agents - description: Public agent directory name: Agent Directory - description: User file storage management name: Files - description: User working memory management name: Memory - description: Scheduled and recurring task management name: Schedules - description: Knowledge base and semantic search name: Knowledge - description: Encrypted user credentials and API keys name: Secrets - description: Neo API key management for programmatic access name: API Keys - description: User profile and account information name: User - description: Task and LLM usage tracking name: Usage - description: Bring Your Own Key provider management name: BYOK - description: Connect personal AI provider accounts and select them as a model source name: AI Connections - description: Model discovery and capabilities name: Models - description: Third-party integrations name: Integrations - description: Skill knowledge documents for agent prompts name: Skills - description: User-authored tools and toolkit management name: Dynamic Tools - description: Team management and member invitations name: Teams - description: Prompt library management and discovery name: Prompts - description: Slack bot integration for workspace installation and OAuth name: Slack - description: GitHub integration for PR reviews and repository management name: GitHub - description: Vulnerability issue tracking and management name: Issues - description: Subscription billing and plans name: Billing - description: Project management and member assignments name: Projects - description: SSH key pair generation and management for remote server access name: SSH Keys - description: Codebase structural analysis and mapping name: Codemaps - description: AI-generated codebase documentation and security analysis name: CodeWiki - description: Captured HTTP traffic query and replay name: Network Events - description: User and team API activity metadata name: Audit Logs - description: Vulnerability triage for HackerOne, GitHub, and Security Inbox name: Triage paths: /api/v1/schedules: post: tags: - Schedules summary: Create schedule description: > Create a new scheduled or one-time task. **Schedule Types:** - `recurring`: Repeating schedule (daily, weekly, monthly, or custom) - `one_time`: Single execution at specified time **For recurring schedules:** - `scan_frequency`: Required - one of daily, weekly, monthly, custom - `start_time`: Optional - HH:MM format for when to run (default: current time) - `custom_weekdays`: For custom - array of weekdays (0=Sunday, 6=Saturday) **For one-time schedules:** - `run_at`: Required - relative ("5m", "1h", "2d") or absolute ("14:30", "3:00PM") time operationId: post-v1-schedules requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateScheduleRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateScheduleResponse' description: Schedule created '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Unauthorized '409': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: A matching Project Autopilot schedule already exists '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Internal server error security: - BearerAuth: [] - ApiKeyAuth: [] components: schemas: CreateScheduleRequest: description: > On the BYOK model source a schedule cannot name a credential: `llm_model` carries no `credential_ref`. A model ID that both a fixed-provider key and a custom endpoint serve runs on the fixed-provider key; a model only a custom endpoint serves runs on that endpoint. properties: custom_weekdays: description: For custom frequency - array of weekdays (0=Sunday, 6=Saturday) items: maximum: 6 minimum: 0 type: integer type: array direct_agent_id: type: string file_keys: description: Optional file references items: type: string type: array llm_model: $ref: '#/components/schemas/ModelType' metadata: additionalProperties: true description: >- Optional metadata for delivery configuration (e.g., Slack channel info for posting results) type: object name: description: Human-readable schedule name maxLength: 256 type: string project_id: description: >- Optional project ID to create a project-scoped schedule (requires project membership) format: uuid type: string reporting_mode: description: >- Output reporting mode - 'full' (default) returns all data, 'changes_only' generates a diff report comparing current results with the previous execution enum: - full - changes_only type: string run_at: description: >- For one_time schedules - relative ("5m", "1h", "2d") or absolute ("14:30", "3:00PM") time type: string scan_frequency: description: Required for recurring schedules enum: - daily - weekly - monthly - custom type: string schedule_type: default: recurring enum: - recurring - one_time type: string secrets: description: >- Optional personal secret names or stable saved-secret references (secret:), reauthorized at each scheduled execution. items: type: string type: array selected_visibility_type: enum: - private - unlisted - team type: string source_task_id: description: The source task/chat ID that this schedule was created from (if any) type: string start_time: description: Start time in HH:MM format (24h) type: string subagent_models: $ref: '#/components/schemas/SubagentModels' description: | Optional subagent model list. The schedule stores it as intent, not as an approved list: every run admits it again against the account's model source at that time. A model that is no longer available pauses the schedule with `worker_model_not_admitted`. subagent_reasoning_effort: $ref: '#/components/schemas/SubagentReasoningEffort' description: >- Optional ceiling for subagent reasoning effort, stored with the schedule and applied on every run. task_message: description: The task message to execute minLength: 1 type: string required: - task_message type: object CreateScheduleResponse: properties: schedule: properties: created_at: format: date-time type: string file_count: type: integer frequency_description: type: string has_files: type: boolean id: format: uuid type: string name: nullable: true type: string next_execution_at: format: date-time nullable: true type: string project_id: description: Project ID if this is a project-scoped schedule format: uuid nullable: true type: string scan_frequency: nullable: true type: string schedule_type: enum: - recurring - one_time type: string status: enum: - active - paused - completed - failed type: string subagent_models: allOf: - $ref: '#/components/schemas/SubagentModels' description: > The subagent model list this schedule is saved with, if any. It is stored as intent, not as an approved list: every run admits it again. subagent_reasoning_effort: allOf: - $ref: '#/components/schemas/SubagentReasoningEffort' description: >- The subagent reasoning effort ceiling this schedule is saved with, if any. required: - id - status - created_at type: object required: - schedule type: object ErrorResponse: properties: code: description: > Stable machine-readable error code — branch on this rather than matching the human `error`/`message` strings. `access_restricted` (HTTP 403) denies hosted Neo access under the access policy. On team invitations, param=email identifies a restricted recipient rather than the caller; show the error without redirecting the caller. Domain codes include `user_spending_cap_reached`, `project_spending_cap_reached`, and `insufficient_neo_credits`; Free/usage codes include `free_grant_challenge_required`, `free_usage_exhausted`, `free_task_budget_exhausted`, `model_not_available_on_free`, `sandbox_not_available_on_free` (cloud sandbox surfaces are not available on the Free plan; task files remain available from the task), `free_cannot_continue_managed_task` (a task that ran on the standard cloud sandbox cannot be continued on the Free plan; start a new task), `free_origin_not_supported` (integration-originated tasks are not available on the Free plan), `weekly_usage_limit_reached`, `billing_period_usage_limit_reached`, `topup_required`, `subscription_required`, and `isolated_workspace_purged`. Otherwise it mirrors the error kind (e.g. `forbidden`, `invalid_request`, `not_exists`, `already_exists`). example: user_spending_cap_reached type: string error: example: Bad request type: string error_id: description: Correlation id for a specific error instance, when present. type: string kind: description: Coarse error category (e.g. "forbidden request", "invalid request"). example: forbidden request type: string message: description: | Human-readable detail (the kind prefixed to the error). For display, not for branching. type: string param: description: >- Field rejected by the policy; email for a restricted invite recipient. type: string turnstile_site_key: description: | Public Cloudflare Turnstile site key returned only with `free_grant_challenge_required`, so the client can complete the invisible verification before retrying the request. type: string required: - error type: object ModelType: description: | LLM model identifier. Values may be Neo model labels or provider-native model IDs discovered at runtime from an AI connection. "auto" defers model selection to the agent, which picks per-request based on task complexity, cost, and security context. minLength: 1 type: string SubagentModels: description: | Optional ordered list of model IDs Neo may use for subagents, exactly as the model source lists them (the main model is always allowed in addition). Use IDs from `/api/v1/models`. At most 50 entries of at most 200 characters each, from the characters `A-Z a-z 0-9 . _ : / @ + -`. Each entry is trimmed and compared exactly, and a repeated entry is dropped, keeping its first position. `auto` is not a subagent model. When set, the list replaces Neo's default subagent models for this request, and the task routes subagents to these models even when `model` is a specific model. A model the model source cannot use is refused with `worker_model_not_admitted`. items: maxLength: 200 minLength: 1 type: string maxItems: 50 type: array SubagentReasoningEffort: default: auto description: | Optional ceiling for the reasoning effort Neo may pick for a subagent. `auto` (the default) sets no ceiling; `low`, `medium`, `high` and `max` cap the effort, and a model that supports less gets its highest supported effort at or below the ceiling. enum: - auto - low - medium - high - max type: string x-enum-varnames: - SubagentReasoningEffortAuto - SubagentReasoningEffortLow - SubagentReasoningEffortMedium - SubagentReasoningEffortHigh - SubagentReasoningEffortMax securitySchemes: BearerAuth: bearerFormat: JWT description: JWT authentication token scheme: bearer type: http ApiKeyAuth: description: Neo API key (neo_sk_* prefix) in: header name: X-Api-Key type: apiKey ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.