POST /projects/{project_reference}/schedulesCreate a recurring schedule that starts a task, a workflow or an agent on a cron expression, or, on REST and GraphQL only, activate a schedule declared in source (the MCP tool creates manual schedules only); returns the schedule: a new schedule is active, and a source schedule that was activated before keeps its current status. Requires project.runs.write.
Servers
[
{
"url": "https://api.veryfront.com"
}
]Authentication
[
{
"bearerAuth": []
},
{
"apiKeyAuth": []
}
]{
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT or API Key",
"description": "Use a JWT bearer token or a Veryfront API key in the `Authorization` header."
},
"apiKeyAuth": {
"type": "apiKey",
"in": "header",
"name": "X-API-Key",
"description": "Alternative API key header for `vf_<prefix>_<secret>` tokens."
}
}Parameters
Parameter contracts
[
{
"schema": {
"type": "string",
"minLength": 1
},
"required": true,
"name": "project_reference",
"in": "path"
}
]Request body
{
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Human-readable schedule name."
},
"target": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"task",
"workflow",
"agent"
],
"description": "Kind of scheduled target."
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Target identifier. For agent schedules, this is the agent ID."
},
"conversation_mode": {
"type": "string",
"enum": [
"create_new",
"existing",
"none"
],
"description": "Conversation behaviour for an agent target. Defaults to none. Use create_new for an agent that delegates with invoke_agent - a run with no conversation cannot be paused for delegation. Agent targets run headlessly by default; create_new or existing creates or appends a conversation message."
},
"conversation_id": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "Existing conversation to continue. Only allowed when conversation_mode is existing, and required in that case."
}
},
"required": [
"kind",
"id"
],
"additionalProperties": false,
"description": "Typed schedule target."
},
"schedule": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Schedule expression, for example a cron expression."
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "IANA timezone used to evaluate the schedule. Defaults to UTC."
},
"runtime_target_kind": {
"type": "string",
"enum": [
"main_branch",
"environment",
"preview_branch"
],
"description": "Runtime target kind for scheduled runs."
},
"runtime_target_environment_id": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "Environment ID when runtime_target_kind is environment."
},
"runtime_target_branch_id": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "Branch ID when runtime_target_kind is preview_branch."
},
"config": {
"type": "object",
"additionalProperties": {},
"description": "Run configuration. For agent schedules, put the run prompt in config.prompt."
},
"timeout_seconds": {
"type": "integer",
"exclusiveMinimum": 0,
"description": "Per-run timeout in seconds."
},
"backoff_limit": {
"type": "integer",
"minimum": 0,
"description": "Retry backoff limit for failed scheduled runs."
},
"concurrency_policy": {
"type": "string",
"enum": [
"Allow",
"Forbid",
"Replace"
],
"description": "How overlapping scheduled runs are handled."
},
"max_runs": {
"type": [
"integer",
"null"
],
"exclusiveMinimum": 0,
"description": "Optional maximum number of scheduled runs."
},
"definition_source": {
"type": "string",
"enum": [
"manual",
"source"
],
"description": "manual (the default), or source to activate a schedule declared in source, which requires source_trigger_id, source_path and source_hash."
},
"source_trigger_id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Trigger id from the source definition. When a schedule with this id already exists, creating it from source can return that schedule with its current status; a paused schedule remains paused."
},
"source_path": {
"type": "string",
"minLength": 1,
"maxLength": 1024,
"description": "Source file path of the source schedule."
},
"source_hash": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Source definition hash of the source schedule."
}
},
"required": [
"name",
"target",
"schedule"
],
"additionalProperties": false
}
}
}
}Responses
201
Created an active recurring project schedule for a task, workflow, or agent target.
{
"description": "Created an active recurring project schedule for a task, workflow, or agent target.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"schedule": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"project_id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"active",
"paused",
"deleting"
]
},
"target": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"task",
"workflow",
"agent"
]
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"conversation_mode": {
"type": "string",
"enum": [
"create_new",
"existing",
"none"
],
"description": "Conversation behaviour for an agent target. Defaults to none. Use create_new for an agent that delegates with invoke_agent - a run with no conversation cannot be paused for delegation. Agent targets run headlessly by default; create_new or existing creates or appends a conversation message."
},
"conversation_id": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "Existing conversation to continue. Only allowed when conversation_mode is existing, and required in that case."
}
},
"required": [
"kind",
"id"
],
"additionalProperties": false
},
"schedule": {
"type": "string"
},
"timezone": {
"type": "string"
},
"runtime_target_kind": {
"type": "string",
"enum": [
"main_branch",
"environment",
"preview_branch"
]
},
"runtime_target_environment_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"runtime_target_branch_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"config": {
"type": "object",
"additionalProperties": {}
},
"timeout_seconds": {
"type": "integer"
},
"backoff_limit": {
"type": "integer"
},
"concurrency_policy": {
"type": "string"
},
"definition_source": {
"type": "string",
"enum": [
"manual",
"source"
]
},
"source_trigger_id": {
"type": [
"string",
"null"
]
},
"source_path": {
"type": [
"string",
"null"
]
},
"source_hash": {
"type": [
"string",
"null"
]
},
"last_scheduled_at": {
"type": [
"string",
"null"
]
},
"last_successful_at": {
"type": [
"string",
"null"
]
},
"health": {
"type": [
"object",
"null"
],
"properties": {
"maxStalenessSeconds": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"maxStalenessSeconds"
],
"additionalProperties": false
},
"max_runs": {
"type": [
"integer",
"null"
],
"exclusiveMinimum": 0
},
"run_count": {
"type": "integer",
"minimum": 0
},
"completed_at": {
"type": [
"string",
"null"
]
},
"paused_reason": {
"type": [
"string",
"null"
]
},
"paused_at": {
"type": [
"string",
"null"
]
},
"last_failure_at": {
"type": [
"string",
"null"
]
},
"last_failure_code": {
"type": [
"string",
"null"
]
},
"last_failure_message": {
"type": [
"string",
"null"
]
},
"last_failure_run_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"created_by": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"integration_requirements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"integration": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-z0-9][a-z0-9_-]*$"
},
"required_scopes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"maxItems": 50,
"default": []
},
"resources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"pattern": "^[a-z][a-z0-9_-]*$"
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 512
},
"parent": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"pattern": "^[a-z][a-z0-9_-]*$"
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"required": [
"kind",
"id"
],
"additionalProperties": false
}
},
"required": [
"kind",
"id"
],
"additionalProperties": false
},
"maxItems": 50,
"default": []
}
},
"required": [
"integration"
],
"additionalProperties": false
},
"maxItems": 20,
"default": []
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"project_id",
"name",
"status",
"target",
"schedule",
"timezone",
"runtime_target_kind",
"runtime_target_environment_id",
"runtime_target_branch_id",
"config",
"timeout_seconds",
"backoff_limit",
"concurrency_policy",
"definition_source",
"source_trigger_id",
"source_path",
"source_hash",
"last_scheduled_at",
"last_successful_at",
"health",
"max_runs",
"run_count",
"completed_at",
"paused_reason",
"paused_at",
"last_failure_at",
"last_failure_code",
"last_failure_message",
"last_failure_run_id",
"created_by",
"created_at",
"updated_at"
],
"additionalProperties": false,
"description": "The created schedule. New schedules are active by default."
}
},
"required": [
"schedule"
]
}
}
}
}400
invalid_input: invalid body or parameters
{
"description": "invalid_input: invalid body or parameters",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}401
unauthenticated
{
"description": "unauthenticated",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}403
forbidden: a project member without project.runs.write
{
"description": "forbidden: a project member without project.runs.write",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}404
not_found: project or target not found or not visible
{
"description": "not_found: project or target not found or not visible",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}500
internal
{
"description": "internal",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}503
internal: authentication state is temporarily unavailable and the request was not processed; retry shortly.
{
"description": "internal: authentication state is temporarily unavailable and the request was not processed; retry shortly.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}Referenced contracts
components/schemas/Problem
{
"type": "object",
"properties": {
"cause": {
"type": "string",
"enum": [
"schedule_concurrency_forbidden",
"schedule_fire_in_progress",
"schedule_run_limit_reached"
],
"description": "Schedule admission refusal."
},
"idempotency": {
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"in_progress",
"payload_mismatch",
"outcome_unknown"
]
},
"operation": {
"type": "string",
"minLength": 1
},
"retryable": {
"type": "boolean"
},
"retry_after_seconds": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"expires_at": {
"type": [
"string",
"null"
]
},
"recovery": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
},
"description": {
"type": "string"
},
"resource_url": {
"type": "string"
}
},
"required": [
"available",
"description"
]
}
},
"required": [
"state",
"operation",
"retryable",
"retry_after_seconds",
"expires_at"
],
"description": "Replay status, retry timing, and recovery lookup."
},
"type": {
"type": "string",
"description": "URI reference identifying the problem type",
"example": "https://api.veryfront.com/errors/validation-failed"
},
"title": {
"type": "string",
"description": "Short human-readable summary of the problem",
"example": "Validation Failed"
},
"status": {
"type": "integer",
"minimum": 100,
"maximum": 599,
"description": "HTTP status code",
"example": 400
},
"code": {
"type": "string",
"description": "Stable machine-readable error code",
"example": "RUN_INVALID_INPUT"
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence",
"example": "The 'email' field must be a valid email address"
},
"instance": {
"type": "string",
"description": "URI reference identifying the specific occurrence",
"example": "/projects/my-project/members"
},
"slug": {
"type": "string",
"description": "Stable identifier for the problem type",
"example": "validation-failed"
},
"category": {
"type": "string",
"enum": [
"AUTH",
"RESOURCE",
"VALIDATION",
"DATABASE",
"SUBSCRIPTION",
"INTEGRATION",
"INTERNAL"
],
"description": "API error category",
"example": "VALIDATION"
},
"suggestion": {
"type": "string",
"description": "Suggested action to resolve the problem",
"example": "Check the request body and query parameters against the API documentation."
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "Field path that caused the error",
"example": "email"
},
"message": {
"type": "string",
"description": "Error message for this field",
"example": "Invalid email format"
},
"code": {
"type": "string",
"description": "Error code for this field",
"example": "INVALID_FORMAT"
}
},
"required": [
"field",
"message"
]
},
"description": "Detailed field-level errors for validation failures"
}
},
"required": [
"type",
"title",
"status"
]
}Operation contract
{
"operationId": "createSchedule",
"tags": [
"execution/Triggers/Project schedules"
],
"summary": "Create schedule",
"description": "Create a recurring schedule that starts a task, a workflow or an agent on a cron expression, or, on REST and GraphQL only, activate a schedule declared in source (the MCP tool creates manual schedules only); returns the schedule: a new schedule is active, and a source schedule that was activated before keeps its current status. Requires project.runs.write.",
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1
},
"required": true,
"name": "project_reference",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Human-readable schedule name."
},
"target": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"task",
"workflow",
"agent"
],
"description": "Kind of scheduled target."
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Target identifier. For agent schedules, this is the agent ID."
},
"conversation_mode": {
"type": "string",
"enum": [
"create_new",
"existing",
"none"
],
"description": "Conversation behaviour for an agent target. Defaults to none. Use create_new for an agent that delegates with invoke_agent - a run with no conversation cannot be paused for delegation. Agent targets run headlessly by default; create_new or existing creates or appends a conversation message."
},
"conversation_id": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "Existing conversation to continue. Only allowed when conversation_mode is existing, and required in that case."
}
},
"required": [
"kind",
"id"
],
"additionalProperties": false,
"description": "Typed schedule target."
},
"schedule": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Schedule expression, for example a cron expression."
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "IANA timezone used to evaluate the schedule. Defaults to UTC."
},
"runtime_target_kind": {
"type": "string",
"enum": [
"main_branch",
"environment",
"preview_branch"
],
"description": "Runtime target kind for scheduled runs."
},
"runtime_target_environment_id": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "Environment ID when runtime_target_kind is environment."
},
"runtime_target_branch_id": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "Branch ID when runtime_target_kind is preview_branch."
},
"config": {
"type": "object",
"additionalProperties": {},
"description": "Run configuration. For agent schedules, put the run prompt in config.prompt."
},
"timeout_seconds": {
"type": "integer",
"exclusiveMinimum": 0,
"description": "Per-run timeout in seconds."
},
"backoff_limit": {
"type": "integer",
"minimum": 0,
"description": "Retry backoff limit for failed scheduled runs."
},
"concurrency_policy": {
"type": "string",
"enum": [
"Allow",
"Forbid",
"Replace"
],
"description": "How overlapping scheduled runs are handled."
},
"max_runs": {
"type": [
"integer",
"null"
],
"exclusiveMinimum": 0,
"description": "Optional maximum number of scheduled runs."
},
"definition_source": {
"type": "string",
"enum": [
"manual",
"source"
],
"description": "manual (the default), or source to activate a schedule declared in source, which requires source_trigger_id, source_path and source_hash."
},
"source_trigger_id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Trigger id from the source definition. When a schedule with this id already exists, creating it from source can return that schedule with its current status; a paused schedule remains paused."
},
"source_path": {
"type": "string",
"minLength": 1,
"maxLength": 1024,
"description": "Source file path of the source schedule."
},
"source_hash": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Source definition hash of the source schedule."
}
},
"required": [
"name",
"target",
"schedule"
],
"additionalProperties": false
}
}
}
},
"responses": {
"201": {
"description": "Created an active recurring project schedule for a task, workflow, or agent target.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"schedule": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"project_id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"active",
"paused",
"deleting"
]
},
"target": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"task",
"workflow",
"agent"
]
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"conversation_mode": {
"type": "string",
"enum": [
"create_new",
"existing",
"none"
],
"description": "Conversation behaviour for an agent target. Defaults to none. Use create_new for an agent that delegates with invoke_agent - a run with no conversation cannot be paused for delegation. Agent targets run headlessly by default; create_new or existing creates or appends a conversation message."
},
"conversation_id": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "Existing conversation to continue. Only allowed when conversation_mode is existing, and required in that case."
}
},
"required": [
"kind",
"id"
],
"additionalProperties": false
},
"schedule": {
"type": "string"
},
"timezone": {
"type": "string"
},
"runtime_target_kind": {
"type": "string",
"enum": [
"main_branch",
"environment",
"preview_branch"
]
},
"runtime_target_environment_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"runtime_target_branch_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"config": {
"type": "object",
"additionalProperties": {}
},
"timeout_seconds": {
"type": "integer"
},
"backoff_limit": {
"type": "integer"
},
"concurrency_policy": {
"type": "string"
},
"definition_source": {
"type": "string",
"enum": [
"manual",
"source"
]
},
"source_trigger_id": {
"type": [
"string",
"null"
]
},
"source_path": {
"type": [
"string",
"null"
]
},
"source_hash": {
"type": [
"string",
"null"
]
},
"last_scheduled_at": {
"type": [
"string",
"null"
]
},
"last_successful_at": {
"type": [
"string",
"null"
]
},
"health": {
"type": [
"object",
"null"
],
"properties": {
"maxStalenessSeconds": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"maxStalenessSeconds"
],
"additionalProperties": false
},
"max_runs": {
"type": [
"integer",
"null"
],
"exclusiveMinimum": 0
},
"run_count": {
"type": "integer",
"minimum": 0
},
"completed_at": {
"type": [
"string",
"null"
]
},
"paused_reason": {
"type": [
"string",
"null"
]
},
"paused_at": {
"type": [
"string",
"null"
]
},
"last_failure_at": {
"type": [
"string",
"null"
]
},
"last_failure_code": {
"type": [
"string",
"null"
]
},
"last_failure_message": {
"type": [
"string",
"null"
]
},
"last_failure_run_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"created_by": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"integration_requirements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"integration": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-z0-9][a-z0-9_-]*$"
},
"required_scopes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"maxItems": 50,
"default": []
},
"resources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"pattern": "^[a-z][a-z0-9_-]*$"
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 512
},
"parent": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"pattern": "^[a-z][a-z0-9_-]*$"
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"required": [
"kind",
"id"
],
"additionalProperties": false
}
},
"required": [
"kind",
"id"
],
"additionalProperties": false
},
"maxItems": 50,
"default": []
}
},
"required": [
"integration"
],
"additionalProperties": false
},
"maxItems": 20,
"default": []
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"project_id",
"name",
"status",
"target",
"schedule",
"timezone",
"runtime_target_kind",
"runtime_target_environment_id",
"runtime_target_branch_id",
"config",
"timeout_seconds",
"backoff_limit",
"concurrency_policy",
"definition_source",
"source_trigger_id",
"source_path",
"source_hash",
"last_scheduled_at",
"last_successful_at",
"health",
"max_runs",
"run_count",
"completed_at",
"paused_reason",
"paused_at",
"last_failure_at",
"last_failure_code",
"last_failure_message",
"last_failure_run_id",
"created_by",
"created_at",
"updated_at"
],
"additionalProperties": false,
"description": "The created schedule. New schedules are active by default."
}
},
"required": [
"schedule"
]
}
}
}
},
"400": {
"description": "invalid_input: invalid body or parameters",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"401": {
"description": "unauthenticated",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"403": {
"description": "forbidden: a project member without project.runs.write",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"404": {
"description": "not_found: project or target not found or not visible",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"500": {
"description": "internal",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"503": {
"description": "internal: authentication state is temporarily unavailable and the request was not processed; retry shortly.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"x-documentation-source-tag": "Project schedules",
"x-canonical-documentation": {
"domain": "execution",
"resource": "Triggers",
"subgroup": "Project schedules",
"name": "Create schedule",
"description": "Create a recurring schedule that starts a task, a workflow or an agent on a cron expression, or, on REST and GraphQL only, activate a schedule declared in source (the MCP tool creates manual schedules only); returns the schedule: a new schedule is active, and a source schedule that was activated before keeps its current status. Requires project.runs.write.",
"operationId": "createSchedule"
},
"x-mint": {
"href": "/cloud/rest/api-reference/execution-triggers-project-schedules/create-schedule"
}
}