Start

Platform

App store purchases

Auth

Builds

Database

Flags

Hosting

Jobs and cron

Localization

Monitoring

Network

Notifications

Organizations

Payments

Queues

Events

Realtime

Runners

Sandboxes

Storage

Webhooks

Workflows

Getting Started

Installation

Authentication

AI Services

KV Store

Overview

Webhooks

Deploy & Infrastructure

Reference

On this page

Request
JobRun
ResourceMeta
Response
ResourceMeta
ScheduleFireRef
JobRunUsage
Errors
Examples

Reference

Create a job run

Starts a run of a Job now.

Checked 2026-09-28

Starts a run of a Job now. The same Idempotency-Key returns the same run for 24h; a Schedule fire uses {job}:{intended time}. With concurrency forbid, a start while a run is active fails with INVALID_STATE.

Path POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/jobs/job/job_runs
Scope workflows:run
Effect write — a successful call changes state.
Collection job_runs
Query job_run_id, validate_only

#Request

Field	Type	What it is
`parent`	`string`	The job to run. Required.
`job_run_id`	`string`	The run id, the final name segment; the server assigns one when empty.
`job_run`	`JobRun`	The run to start: `args` and `env` override the Job's for this run. Required.
`validate_only`	`bool`	Validate and return the result without starting anything.

#JobRun

Field	Type	What it is
`name`	`string`	`orgs/{org}/projects/{project}/envs/{env}/jobs/{job}/job_runs/{job_run}`.
`meta`	`ResourceMeta`	Resource metadata.
`args`	`string[]`	Arguments of this run (the Job's when empty).
`env`	`map<string, string>`	Environment overrides of this run.
`schedule_time`	`timestamp`	Start no earlier than this: set it directly, or through `start_delay`; at most 365 days ahead. A run cancelled before then makes no attempt.
`start_delay`	`duration`	Start no earlier than this long after the request.

#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.

#Response

Field	Type	What it is
`name`	`string`	`orgs/{org}/projects/{project}/envs/{env}/jobs/{job}/job_runs/{job_run}`.
`uid`	`string`	`jrun_<cell><ulid>`; never reused. Output only.
`meta`	`ResourceMeta`	Resource metadata.
`job_generation`	`int64`	The Job generation the run pinned. Output only.
`resolved_image`	`string`	The image digest the run executes. Output only.
`args`	`string[]`	Arguments of this run (the Job's when empty).
`env`	`map<string, string>`	Environment overrides of this run.
`state`	`JobRunState`	The run's lifecycle state. Output only. One of `queued`, `running`, `succeeded`, `failed`, `cancelled`, `timed_out`.
`exit_code`	`int32`	The last attempt's exit code, once it exited. Output only.
`attempt_count`	`int32`	Attempts made so far. Output only.
`termination_reason`	`string`	Why the last attempt ended other than by exiting, for example `OOMKilled` or `Evicted`. Output only.
`schedule_fire`	`ScheduleFireRef`	Set when a Schedule fire started the run. Output only.
`create_time`	`timestamp`	When the run was accepted. Output only.
`start_time`	`timestamp`	When the first attempt started. Output only.
`end_time`	`timestamp`	When the run closed. Output only.
`usage`	`JobRunUsage`	Metered usage across attempts. Output only.
`message`	`string`	Why the run failed or was refused, when it did. Output only.
`schedule_time`	`timestamp`	Start no earlier than this: set it directly, or through `start_delay`; at most 365 days ahead. A run cancelled before then makes no attempt.
`start_delay`	`duration`	Start no earlier than this long after the request.

#ResourceMeta

Field	Type	What it is
`generation`	`int64`	Increases by one on every change to `spec`. Output only.
`etag`	`string`	Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as `If-Match` or `etag` to make Update and Delete conditional; a mismatch fails with ABORTED / 409 `ETAG_MISMATCH`. Output only.
`create_time`	`timestamp`	When the Resource was created. Output only.
`update_time`	`timestamp`	When the Resource last changed. Output only.
`delete_time`	`timestamp`	Set while the Resource is being deleted. Output only.
`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.
`creator`	`string`	The principal that created the Resource. Output only.

#ScheduleFireRef

Field	Type	What it is
`schedule`	`string`	The Schedule. Output only.
`intended_time`	`timestamp`	The instant the fire was due. Output only.

#JobRunUsage

Field	Type	What it is
`billed_duration`	`duration`	Summed wall time of every attempt from start to exit; billed as this duration on `instance_type` (`workflows.job.seconds`). Output only.
`instance_type`	`string`	The instance type the attempts ran on. Output only.

#Errors

UNAUTHENTICATED — No valid key or token was presented.
PERMISSION_DENIED — The key lacks the method's permission.
RESOURCE_NOT_FOUND — The named Resource does not exist or is not visible.
UNKNOWN_FIELD — The request has a field the schema does not know.
INVALID_FIELD — A field failed validation.
INVALID_STATE — The Resource is in a state that forbids the call.
RESOURCE_ALREADY_EXISTS — A Resource with this name exists.
IDEMPOTENCY_KEY_REUSED — An Idempotency-Key was reused with another body.
IDEMPOTENCY_IN_PROGRESS — The first call with this Idempotency-Key is still running.
PLAN_LIMIT_REACHED — The plan's limit is reached.

Every error arrives in the body Errors describes.

#Examples

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

Was this page helpful?

Tell us what is missing, wrong, or unclear — this opens a real inbox.

Send feedback

Platform links