---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Create a schedule"
description: "`workflows.schedules.create` (POST /v1/{parent}/schedules): Creates a schedule."
type: reference
product: jobs
summary: "Creates a schedule."
updated: 2026-09-28
nav: false
---

> **This method is not served on the public API.** `api.sylphx.com` does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

Creates a schedule.

- **Path** `POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/schedules`
- **Scope** `workflows:write`
- **Effect** `write` — a successful call changes state.
- **Collection** [schedules](/docs/api/schedules)
- **Query** `schedule_id`, `validate_only`
- **Operation** answers with an `Operation`; the result is `Schedule`

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `parent` | `string` | The parent to create in. Required. |
| `schedule_id` | `string` | The schedule id, the final name segment; the server assigns one when empty. |
| `schedule` | `Schedule` | The schedule to create; only caller-writable fields are read. Required. |
| `validate_only` | `bool` | Validate and return the result without writing anything. |

### Schedule

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/schedules/{schedule}`. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `ScheduleSpec` | Desired state. Required. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |

### ScheduleSpec

| Field | Type | What it is |
| --- | --- | --- |
| `workflow` | `string` | The Workflow the Schedule starts, in the same environment. Required. |
| `input` | `struct` | The input of every Run, at most 64 KiB of JSON. |
| `calendar` | `CalendarSpec` | A calendar: cron expression and time zone. One of the `trigger` group. |
| `interval` | `IntervalSpec` | A fixed interval. One of the `trigger` group. |
| `jitter` | `duration` | Random delay added to each fire, at most min(interval, 1h). |
| `overlap_policy` | `OverlapPolicy` | What a fire does while a previous Run is still running. One of `skip`, `buffer_one`, `buffer_all`, `cancel_other`, `allow`. |
| `catchup_window` | `duration` | Missed fires older than this are skipped; 10s to 365d. |
| `paused` | `bool` | Whether fires are paused. |
| `pause_note` | `string` | Why the Schedule is paused; shown in status. |

### CalendarSpec

| Field | Type | What it is |
| --- | --- | --- |
| `cron` | `string` | A 5-field cron expression, for example `0 3 * * *`. Required. |
| `time_zone` | `string` | IANA time zone; default `UTC`. |

### IntervalSpec

| Field | Type | What it is |
| --- | --- | --- |
| `every` | `duration` | The period, 1s to 365d. Required. |
| `offset` | `duration` | Phase offset within each period. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `{parent-of-target}/operations/{operation}`. |
| `target` | `string` | The name of the Resource being changed. |
| `target_generation` | `int64` | The generation this Operation waits for. |
| `verb` | `OperationVerb` | What the Operation does. One of `create`, `update`, `delete`, `custom`. |
| `custom_verb` | `string` | The custom method verb when `verb` is CUSTOM, for example `revoke`. |
| `done` | `bool` | Whether the Operation has finished. |
| `create_time` | `timestamp` | When the Operation started. |
| `end_time` | `timestamp` | When the Operation finished. |
| `response` | `any` | The settled Resource (or Empty for a delete). One of the `result` group. |
| `error` | `ProblemDetails` | The failure, as the one error body. One of the `result` group. |
| `progress` | `OperationProgress` | Progress while not `done`. |

### ProblemDetails

| Field | Type | What it is |
| --- | --- | --- |
| `type` | `string` | `https://sylphx.com/docs/errors/<code in kebab-case>`. |
| `title` | `string` | A short customer-safe summary of the problem class. |
| `status` | `int32` | The HTTP status, fixed by `grpc_status`. |
| `detail` | `string` | A customer-safe explanation of this occurrence. Never contains SQL, stack traces, internal hostnames, or another tenant's data. |
| `instance` | `string` | The request id (`Sylphx-Request-Id`). |
| `code` | `string` | The stable UPPER_SNAKE code, one of ErrorCode without its prefix. |
| `grpc_status` | `string` | One of the 16 canonical gRPC status names, for example `ABORTED`. |
| `retryable` | `bool` | Whether the same request may be retried. |
| `effect` | `ErrorEffect` | What the failed call committed. One of `none`, `applied`, `unknown`. |
| `retry_after_ms` | `int64` | How long to wait before retrying, when the server knows. |
| `details` | `any[]` | Typed details such as PreconditionFailure or EntitlementDenial. |

### OperationProgress

| Field | Type | What it is |
| --- | --- | --- |
| `percent` | `int32` | Percent complete, when the controller can tell. |
| `message` | `string` | A customer-safe progress message. |
| `conditions` | `Condition[]` | The target's conditions when this progress was read. |

### Condition

| Field | Type | What it is |
| --- | --- | --- |
| `type` | `string` | The condition type, for example `Ready`. |
| `status` | `ConditionStatus` | Whether the condition holds. One of `true`, `false`, `unknown`. |
| `observed_generation` | `int64` | The generation this observation was made against. |
| `reason` | `string` | A machine-readable UpperCamelCase reason. |
| `message` | `string` | A customer-safe human-readable message. |
| `severity` | `Severity` | How severe a FALSE condition is. One of `info`, `warning`, `error`. |
| `transition_time` | `timestamp` | When `status` last changed. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`UNKNOWN_FIELD`](/docs/api/errors/UNKNOWN_FIELD) — The request has a field the schema does not know.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.
- [`RESOURCE_ALREADY_EXISTS`](/docs/api/errors/RESOURCE_ALREADY_EXISTS) — A Resource with this name exists.
- [`IDEMPOTENCY_KEY_REUSED`](/docs/api/errors/IDEMPOTENCY_KEY_REUSED) — An Idempotency-Key was reused with another body.
- [`IDEMPOTENCY_IN_PROGRESS`](/docs/api/errors/IDEMPOTENCY_IN_PROGRESS) — The first call with this Idempotency-Key is still running.
- [`PLAN_LIMIT_REACHED`](/docs/api/errors/PLAN_LIMIT_REACHED) — The plan's limit is reached.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/schedules" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"spec":{"workflow":"…"}}'
```

**TypeScript**

```ts
const operation = await sylphx.workflows.schedules.create({ parent: 'orgs/acme/projects/shop/envs/production', schedule: { spec: { workflow: '…' } } })
```

**Rust**

```rust
let mut req = sylphx::workflows::CreateScheduleRequest::default();
req.parent = "orgs/acme/projects/shop/envs/production".to_string();
req.schedule = Some(sylphx::workflows::Schedule {
    spec: Some(sylphx::workflows::ScheduleSpec {
        workflow: "…".to_string(),
        ..Default::default()
    }),
    ..Default::default()
});
let operation = sx.workflows().schedules().create(req).await?;
```

**CLI**

```bash
sylphx workflows schedules create --parent orgs/acme/projects/shop/envs/production --spec.workflow …
```

**Terraform**

```hcl
resource "sylphx_workflows_schedule" "schedule" {
  schedule_id = "schedule"
  parent      = "orgs/acme/projects/shop/envs/production"
  spec        = { workflow = "…" }
}
```

**MCP**

```json
{ "method_id": "workflows.schedules.create", "args": {"parent":"orgs/acme/projects/shop/envs/production","schedule":{"spec":{"workflow":"…"}}} }
```