Skip to main content
GET
GET jobs details
Fetch full details for a Job, including its container image, asset dependencies, parent-job dependencies, and the structured arguments schema rendered as field groups suitable for building a UI form. This endpoint is intended for Custom Workflows only.

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string
required

Response

200 - application/json

OK

autorun_on_org_sample_upload
boolean
required

Whether this job runs automatically on every newly uploaded sample in the user's organization.

image_uri
string
required

Fully qualified OCI image URI used to run the job.

inject_bearer_token
boolean
required

Whether the user's One Codex bearer token is injected into the analysis job as $ONE_CODEX_BEARER_TOKEN.

job_type
enum<string>
required

Whether this is a shell script or a Nextflow job.

Available options:
shell_script,
nextflow
script
string
required

The script that is executed when the job runs.

arguments_schema
FieldGroup · object[] | null

The schema for the arguments to parametrize this job. Each field is exposed in the script as $ARGS_<UPPER_NAME>. Example: [{"fields": [{"name": "min_quality", "type": "integer"}, {"name": "adapter", "type": "string"}]}]. The input sample is not a parameter; it is passed separately at run time

assets
Assets · object[] | null

An optional list of assets associated with this job

cpu
number | null

The number of CPU cores used for this job, set only for shell script jobs

dependencies
JobDependencySchema · object[] | null

Optional job dependencies for this job. If provided, will be triggered automatically when this job is run

description
string | null

The human-readable description of the job. Supports markdown

ram_gb
number | null

The amount of RAM used for this job in GB, set only for shell script jobs

repository
RepositorySchema · object | null

The git repository that this job runs against

storage_gb
number | null

The amount of storage used for this job in GB, set only for shell script jobs