Pipeline execution images¶
Create and manage the execution images pipelines run in, including image versions and their build logs.
List execution images¶
Operation path: GET /api/v2/pipelines/images
List the execution images accessible to the authenticated user, newest first.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| offset | query | integer | false | none |
| limit | query | integer | false | none |
Example responses¶
200 Response
{
"properties": {
"count": {
"readOnly": true,
"title": "Count",
"type": "integer"
},
"data": {
"items": {
"description": "Lightweight response schema used by the list endpoint. attributes: image_id: public-facing 24-char Mongodb objectid hex string. name: user-provided image name. description: optional description. latest_version: highest version number currently registered. latest_status: build status of the latest version. created_at: row creation timestamp. updated_at: last modification timestamp.",
"properties": {
"createdAt": {
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"id": {
"maxLength": 24,
"minLength": 24,
"pattern": "^[0-9a-fA-F]{24}$",
"title": "Id",
"type": "string"
},
"latestStatus": {
"description": "Build status of a pipeline image version.",
"enum": [
"CREATING",
"READY",
"ERROR"
],
"title": "PipelineImageStatus",
"type": "string"
},
"latestVersion": {
"title": "Latestversion",
"type": "integer"
},
"name": {
"title": "Name",
"type": "string"
},
"updatedAt": {
"format": "date-time",
"title": "Updatedat",
"type": "string"
}
},
"required": [
"id",
"name",
"latestVersion",
"latestStatus",
"createdAt",
"updatedAt"
],
"title": "PipelineImageSummaryResponse",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
},
"totalCount": {
"title": "Totalcount",
"type": "integer"
}
},
"required": [
"data",
"totalCount",
"count"
],
"title": "DataPage[PipelineImageSummaryResponse]",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful Response | DataPage_PipelineImageSummaryResponse_ |
| 422 | Unprocessable Entity | Validation Error | HTTPValidationError |
Create execution image¶
Operation path: POST /api/v2/pipelines/images
Create an execution image for pipelines and start its first build.
Body parameter¶
{
"description": "Request body for ``post /pipelines/images``. carries the canonical image definition plus an optional human-readable description. the description is stored on the parent ``pipelineimage`` row, not the version. ``conda`` is accepted but not shown in the openapi schema; use ``packages`` (pip specifiers) and ``pythonversion`` as the primary fields. ``gpu`` is documented but gated by the ``gpu_enabled`` flag (422 when off). ``is_ephemeral`` (wire: ``isephemeral``) marks the built image for automatic cleanup by the image build service (deleted from the registry ~48h after build). defaults to ``false`` so real pipeline images remain durable for the life of the pipeline; acceptance/regression tests set it ``true`` so their throwaway build artifacts are auto-gc'd instead of accumulating in the registry. named to match build-service's own ``is_ephemeral`` build flag. not part of the persisted image definition (a build-time directive, like ``description``), so it does not affect version dedup.",
"properties": {
"description": {
"anyOf": [
{
"maxLength": 2048,
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"gpu": {
"default": false,
"description": "Request gpu support for the built image. a pod-scheduling signal (gpu resource claim + tolerations + affinity applied at dispatch); the image bakes no cuda by default — bring your own gpu wheels. gated by the environment's gpu capacity: when gpu support is not enabled a ``gpu: true`` request is rejected with 422. accepted as the deprecated alias ``nvidia``.",
"title": "Gpu",
"type": "boolean"
},
"name": {
"maxLength": 255,
"minLength": 1,
"title": "Name",
"type": "string"
},
"packages": {
"items": {
"type": "string"
},
"title": "Packages",
"type": "array"
},
"pythonBaseImage": {
"anyOf": [
{
"maxLength": 512,
"type": "string"
},
{
"type": "null"
}
],
"deprecated": true,
"description": "Deprecated — use ``pythonversion``. a bare ``major.minor`` value is folded into ``pythonversion``; a full image reference is accepted but ignored at build time (it would bypass the fips base image).",
"title": "Pythonbaseimage"
},
"pythonVersion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Python interpreter version for the built image, e.g. ``3.11``. selects the DR runtime base-image tag; the venv is built against this interpreter. allowed: 3.10, 3.11, 3.12, 3.13. when omitted, the runtime template's default applies.",
"title": "Pythonversion"
}
},
"required": [
"name"
],
"title": "PipelineImageCreateRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | PipelineImageCreateRequest | true | none |
Example responses¶
201 Response
{
"description": "Detailed response schema for a pipeline image. attributes: image_id: public-facing 24-char Mongodb objectid hex string. name: user-provided image name. description: optional description. latest_version: highest version number currently registered. versions: all versions ordered newest-first. created_at: row creation timestamp. updated_at: last modification timestamp.",
"properties": {
"createdAt": {
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"id": {
"maxLength": 24,
"minLength": 24,
"pattern": "^[0-9a-fA-F]{24}$",
"title": "Id",
"type": "string"
},
"latestVersion": {
"title": "Latestversion",
"type": "integer"
},
"name": {
"title": "Name",
"type": "string"
},
"updatedAt": {
"format": "date-time",
"title": "Updatedat",
"type": "string"
},
"versions": {
"items": {
"description": "Response schema for a single image version. carries the full ``definition`` round-trip so clients see exactly what was sent at create time. ``status`` / ``error_detail`` reflect the build outcome. ``image_uri`` is populated once an ibs-direct build completes successfully.",
"properties": {
"createdAt": {
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"definition": {
"description": "Canonical image definition stored on ``pipelineimageversion``. ``packages`` maps to covalent's ``pip`` kwarg. ``python_base_image`` maps to covalent's ``base_image`` kwarg. ``gpu`` maps to covalent's ``nvidia`` kwarg (a pod-scheduling signal). ``conda`` is supported for power users but not surfaced in the public API schema. persisted as jsonb in ``pipelineimageversion.definition``.",
"properties": {
"conda": {
"anyOf": [
{
"description": "Structured conda specification with explicit channels and dependencies. equivalent to the dict-form ``conda`` kwarg of ``covalent.create_env``: .. code-block:: Python conda={ \"channels\": [\"conda-forge\", \"defaults\"], \"dependencies\": [\"numpy=1.21.*\", \"xarray=0.15.1\"], }.",
"properties": {
"channels": {
"items": {
"type": "string"
},
"title": "Channels",
"type": "array"
},
"dependencies": {
"items": {
"type": "string"
},
"title": "Dependencies",
"type": "array"
}
},
"title": "CondaSpec",
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"title": "Conda"
},
"gpu": {
"default": false,
"description": "Request gpu support for the built image. a pod-scheduling signal (gpu resource claim + tolerations + affinity applied at dispatch); the image bakes no cuda by default — bring your own gpu wheels. gated by the environment's gpu capacity: when gpu support is not enabled a ``gpu: true`` request is rejected with 422. accepted as the deprecated alias ``nvidia``.",
"title": "Gpu",
"type": "boolean"
},
"name": {
"maxLength": 255,
"minLength": 1,
"title": "Name",
"type": "string"
},
"packages": {
"items": {
"type": "string"
},
"title": "Packages",
"type": "array"
},
"pythonBaseImage": {
"anyOf": [
{
"maxLength": 512,
"type": "string"
},
{
"type": "null"
}
],
"deprecated": true,
"description": "Deprecated — use ``pythonversion``. a bare ``major.minor`` value is folded into ``pythonversion``; a full image reference is accepted but ignored at build time (it would bypass the fips base image).",
"title": "Pythonbaseimage"
},
"pythonVersion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Python interpreter version for the built image, e.g. ``3.11``. selects the DR runtime base-image tag; the venv is built against this interpreter. allowed: 3.10, 3.11, 3.12, 3.13. when omitted, the runtime template's default applies.",
"title": "Pythonversion"
}
},
"required": [
"name"
],
"title": "PipelineImageDefinition",
"type": "object"
},
"errorDetail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Errordetail"
},
"imageUri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Imageuri"
},
"status": {
"description": "Build status of a pipeline image version.",
"enum": [
"CREATING",
"READY",
"ERROR"
],
"title": "PipelineImageStatus",
"type": "string"
},
"updatedAt": {
"format": "date-time",
"title": "Updatedat",
"type": "string"
},
"version": {
"title": "Version",
"type": "integer"
}
},
"required": [
"version",
"definition",
"status",
"createdAt",
"updatedAt"
],
"title": "PipelineImageVersionResponse",
"type": "object"
},
"title": "Versions",
"type": "array"
}
},
"required": [
"id",
"name",
"latestVersion",
"versions",
"createdAt",
"updatedAt"
],
"title": "PipelineImageResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Successful Response | PipelineImageResponse |
| 422 | Unprocessable Entity | Validation Error | HTTPValidationError |
Delete execution image by image_ ID¶
Operation path: DELETE /api/v2/pipelines/images/{image_id}
Delete an execution image and all of its versions.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| image_id | path | string | true | Execution image ID |
Example responses¶
422 Response
{
"properties": {
"detail": {
"items": {
"properties": {
"ctx": {
"title": "Context",
"type": "object"
},
"input": {
"title": "Input"
},
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"title": "Location",
"type": "array"
},
"msg": {
"title": "Message",
"type": "string"
},
"type": {
"title": "Error Type",
"type": "string"
}
},
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError",
"type": "object"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Successful Response | None |
| 422 | Unprocessable Entity | Validation Error | HTTPValidationError |
Get execution image by image_ ID¶
Operation path: GET /api/v2/pipelines/images/{image_id}
Retrieve an execution image, including its versions.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| image_id | path | string | true | Execution image ID |
Example responses¶
200 Response
{
"description": "Detailed response schema for a pipeline image. attributes: image_id: public-facing 24-char Mongodb objectid hex string. name: user-provided image name. description: optional description. latest_version: highest version number currently registered. versions: all versions ordered newest-first. created_at: row creation timestamp. updated_at: last modification timestamp.",
"properties": {
"createdAt": {
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"id": {
"maxLength": 24,
"minLength": 24,
"pattern": "^[0-9a-fA-F]{24}$",
"title": "Id",
"type": "string"
},
"latestVersion": {
"title": "Latestversion",
"type": "integer"
},
"name": {
"title": "Name",
"type": "string"
},
"updatedAt": {
"format": "date-time",
"title": "Updatedat",
"type": "string"
},
"versions": {
"items": {
"description": "Response schema for a single image version. carries the full ``definition`` round-trip so clients see exactly what was sent at create time. ``status`` / ``error_detail`` reflect the build outcome. ``image_uri`` is populated once an ibs-direct build completes successfully.",
"properties": {
"createdAt": {
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"definition": {
"description": "Canonical image definition stored on ``pipelineimageversion``. ``packages`` maps to covalent's ``pip`` kwarg. ``python_base_image`` maps to covalent's ``base_image`` kwarg. ``gpu`` maps to covalent's ``nvidia`` kwarg (a pod-scheduling signal). ``conda`` is supported for power users but not surfaced in the public API schema. persisted as jsonb in ``pipelineimageversion.definition``.",
"properties": {
"conda": {
"anyOf": [
{
"description": "Structured conda specification with explicit channels and dependencies. equivalent to the dict-form ``conda`` kwarg of ``covalent.create_env``: .. code-block:: Python conda={ \"channels\": [\"conda-forge\", \"defaults\"], \"dependencies\": [\"numpy=1.21.*\", \"xarray=0.15.1\"], }.",
"properties": {
"channels": {
"items": {
"type": "string"
},
"title": "Channels",
"type": "array"
},
"dependencies": {
"items": {
"type": "string"
},
"title": "Dependencies",
"type": "array"
}
},
"title": "CondaSpec",
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"title": "Conda"
},
"gpu": {
"default": false,
"description": "Request gpu support for the built image. a pod-scheduling signal (gpu resource claim + tolerations + affinity applied at dispatch); the image bakes no cuda by default — bring your own gpu wheels. gated by the environment's gpu capacity: when gpu support is not enabled a ``gpu: true`` request is rejected with 422. accepted as the deprecated alias ``nvidia``.",
"title": "Gpu",
"type": "boolean"
},
"name": {
"maxLength": 255,
"minLength": 1,
"title": "Name",
"type": "string"
},
"packages": {
"items": {
"type": "string"
},
"title": "Packages",
"type": "array"
},
"pythonBaseImage": {
"anyOf": [
{
"maxLength": 512,
"type": "string"
},
{
"type": "null"
}
],
"deprecated": true,
"description": "Deprecated — use ``pythonversion``. a bare ``major.minor`` value is folded into ``pythonversion``; a full image reference is accepted but ignored at build time (it would bypass the fips base image).",
"title": "Pythonbaseimage"
},
"pythonVersion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Python interpreter version for the built image, e.g. ``3.11``. selects the DR runtime base-image tag; the venv is built against this interpreter. allowed: 3.10, 3.11, 3.12, 3.13. when omitted, the runtime template's default applies.",
"title": "Pythonversion"
}
},
"required": [
"name"
],
"title": "PipelineImageDefinition",
"type": "object"
},
"errorDetail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Errordetail"
},
"imageUri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Imageuri"
},
"status": {
"description": "Build status of a pipeline image version.",
"enum": [
"CREATING",
"READY",
"ERROR"
],
"title": "PipelineImageStatus",
"type": "string"
},
"updatedAt": {
"format": "date-time",
"title": "Updatedat",
"type": "string"
},
"version": {
"title": "Version",
"type": "integer"
}
},
"required": [
"version",
"definition",
"status",
"createdAt",
"updatedAt"
],
"title": "PipelineImageVersionResponse",
"type": "object"
},
"title": "Versions",
"type": "array"
}
},
"required": [
"id",
"name",
"latestVersion",
"versions",
"createdAt",
"updatedAt"
],
"title": "PipelineImageResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful Response | PipelineImageResponse |
| 422 | Unprocessable Entity | Validation Error | HTTPValidationError |
Update execution image by image_ ID¶
Operation path: PATCH /api/v2/pipelines/images/{image_id}
Add packages to an execution image, creating and building a new image version.
Body parameter¶
{
"description": "Request body for ``patch /pipelines/images/{image_id}``. creates a new immutable ``pipelineimageversion`` carrying the full definition supplied here. the previous version is left untouched — pipelines locked against it keep working. replacement semantics: the body is a complete redefinition, not a merge. to \"add a package\" the caller posts the previous definition plus the new entry. ``conda`` is accepted but not shown in the openapi schema. ``gpu`` is documented but gated by the ``gpu_enabled`` flag (422 when off). ``is_ephemeral`` (wire: ``isephemeral``, default ``false``) marks the new version's build for automatic ibs cleanup — see ``pipelineimagecreaterequest``. build-time directive only; not persisted in the definition.",
"properties": {
"gpu": {
"default": false,
"description": "Request gpu support for the built image. a pod-scheduling signal (gpu resource claim + tolerations + affinity applied at dispatch); the image bakes no cuda by default — bring your own gpu wheels. gated by the environment's gpu capacity: when gpu support is not enabled a ``gpu: true`` request is rejected with 422. accepted as the deprecated alias ``nvidia``.",
"title": "Gpu",
"type": "boolean"
},
"name": {
"maxLength": 255,
"minLength": 1,
"title": "Name",
"type": "string"
},
"packages": {
"items": {
"type": "string"
},
"title": "Packages",
"type": "array"
},
"pythonBaseImage": {
"anyOf": [
{
"maxLength": 512,
"type": "string"
},
{
"type": "null"
}
],
"deprecated": true,
"description": "Deprecated — use ``pythonversion``. a bare ``major.minor`` value is folded into ``pythonversion``; a full image reference is accepted but ignored at build time (it would bypass the fips base image).",
"title": "Pythonbaseimage"
},
"pythonVersion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Python interpreter version for the built image, e.g. ``3.11``. selects the DR runtime base-image tag; the venv is built against this interpreter. allowed: 3.10, 3.11, 3.12, 3.13. when omitted, the runtime template's default applies.",
"title": "Pythonversion"
}
},
"required": [
"name"
],
"title": "PipelineImageUpdateRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| image_id | path | string | true | Execution image ID |
| body | body | PipelineImageUpdateRequest | true | none |
Example responses¶
200 Response
{
"description": "Detailed response schema for a pipeline image. attributes: image_id: public-facing 24-char Mongodb objectid hex string. name: user-provided image name. description: optional description. latest_version: highest version number currently registered. versions: all versions ordered newest-first. created_at: row creation timestamp. updated_at: last modification timestamp.",
"properties": {
"createdAt": {
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"id": {
"maxLength": 24,
"minLength": 24,
"pattern": "^[0-9a-fA-F]{24}$",
"title": "Id",
"type": "string"
},
"latestVersion": {
"title": "Latestversion",
"type": "integer"
},
"name": {
"title": "Name",
"type": "string"
},
"updatedAt": {
"format": "date-time",
"title": "Updatedat",
"type": "string"
},
"versions": {
"items": {
"description": "Response schema for a single image version. carries the full ``definition`` round-trip so clients see exactly what was sent at create time. ``status`` / ``error_detail`` reflect the build outcome. ``image_uri`` is populated once an ibs-direct build completes successfully.",
"properties": {
"createdAt": {
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"definition": {
"description": "Canonical image definition stored on ``pipelineimageversion``. ``packages`` maps to covalent's ``pip`` kwarg. ``python_base_image`` maps to covalent's ``base_image`` kwarg. ``gpu`` maps to covalent's ``nvidia`` kwarg (a pod-scheduling signal). ``conda`` is supported for power users but not surfaced in the public API schema. persisted as jsonb in ``pipelineimageversion.definition``.",
"properties": {
"conda": {
"anyOf": [
{
"description": "Structured conda specification with explicit channels and dependencies. equivalent to the dict-form ``conda`` kwarg of ``covalent.create_env``: .. code-block:: Python conda={ \"channels\": [\"conda-forge\", \"defaults\"], \"dependencies\": [\"numpy=1.21.*\", \"xarray=0.15.1\"], }.",
"properties": {
"channels": {
"items": {
"type": "string"
},
"title": "Channels",
"type": "array"
},
"dependencies": {
"items": {
"type": "string"
},
"title": "Dependencies",
"type": "array"
}
},
"title": "CondaSpec",
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"title": "Conda"
},
"gpu": {
"default": false,
"description": "Request gpu support for the built image. a pod-scheduling signal (gpu resource claim + tolerations + affinity applied at dispatch); the image bakes no cuda by default — bring your own gpu wheels. gated by the environment's gpu capacity: when gpu support is not enabled a ``gpu: true`` request is rejected with 422. accepted as the deprecated alias ``nvidia``.",
"title": "Gpu",
"type": "boolean"
},
"name": {
"maxLength": 255,
"minLength": 1,
"title": "Name",
"type": "string"
},
"packages": {
"items": {
"type": "string"
},
"title": "Packages",
"type": "array"
},
"pythonBaseImage": {
"anyOf": [
{
"maxLength": 512,
"type": "string"
},
{
"type": "null"
}
],
"deprecated": true,
"description": "Deprecated — use ``pythonversion``. a bare ``major.minor`` value is folded into ``pythonversion``; a full image reference is accepted but ignored at build time (it would bypass the fips base image).",
"title": "Pythonbaseimage"
},
"pythonVersion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Python interpreter version for the built image, e.g. ``3.11``. selects the DR runtime base-image tag; the venv is built against this interpreter. allowed: 3.10, 3.11, 3.12, 3.13. when omitted, the runtime template's default applies.",
"title": "Pythonversion"
}
},
"required": [
"name"
],
"title": "PipelineImageDefinition",
"type": "object"
},
"errorDetail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Errordetail"
},
"imageUri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Imageuri"
},
"status": {
"description": "Build status of a pipeline image version.",
"enum": [
"CREATING",
"READY",
"ERROR"
],
"title": "PipelineImageStatus",
"type": "string"
},
"updatedAt": {
"format": "date-time",
"title": "Updatedat",
"type": "string"
},
"version": {
"title": "Version",
"type": "integer"
}
},
"required": [
"version",
"definition",
"status",
"createdAt",
"updatedAt"
],
"title": "PipelineImageVersionResponse",
"type": "object"
},
"title": "Versions",
"type": "array"
}
},
"required": [
"id",
"name",
"latestVersion",
"versions",
"createdAt",
"updatedAt"
],
"title": "PipelineImageResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful Response | PipelineImageResponse |
| 422 | Unprocessable Entity | Validation Error | HTTPValidationError |
Delete execution image version by image_ ID¶
Operation path: DELETE /api/v2/pipelines/images/{image_id}/versions/{version_id}
Delete a version of an execution image.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| image_id | path | string | true | Execution image ID |
| version_id | path | integer | true | Execution image version number |
Example responses¶
422 Response
{
"properties": {
"detail": {
"items": {
"properties": {
"ctx": {
"title": "Context",
"type": "object"
},
"input": {
"title": "Input"
},
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"title": "Location",
"type": "array"
},
"msg": {
"title": "Message",
"type": "string"
},
"type": {
"title": "Error Type",
"type": "string"
}
},
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError",
"type": "object"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Successful Response | None |
| 422 | Unprocessable Entity | Validation Error | HTTPValidationError |
Get execution image build logs by image_ ID¶
Operation path: GET /api/v2/pipelines/images/{image_id}/versions/{version_id}/logs
Retrieve the build log of an execution image version.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| image_id | path | string | true | Execution image ID |
| version_id | path | integer | true | Execution image version number |
Example responses¶
200 Response
{
"description": "Response schema for image build logs. attributes: logs: full raw build output as a utf-8 decoded string.",
"properties": {
"logs": {
"title": "Logs",
"type": "string"
}
},
"required": [
"logs"
],
"title": "PipelineImageLogsResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful Response | PipelineImageLogsResponse |
| 422 | Unprocessable Entity | Validation Error | HTTPValidationError |
Schemas¶
CondaSpec
{
"description": "Structured conda specification with explicit channels and dependencies. equivalent to the dict-form ``conda`` kwarg of ``covalent.create_env``: .. code-block:: Python conda={ \"channels\": [\"conda-forge\", \"defaults\"], \"dependencies\": [\"numpy=1.21.*\", \"xarray=0.15.1\"], }.",
"properties": {
"channels": {
"items": {
"type": "string"
},
"title": "Channels",
"type": "array"
},
"dependencies": {
"items": {
"type": "string"
},
"title": "Dependencies",
"type": "array"
}
},
"title": "CondaSpec",
"type": "object"
}
CondaSpec
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| channels | [string] | false | none | |
| dependencies | [string] | false | none |
DataPage_PipelineImageSummaryResponse_
{
"properties": {
"count": {
"readOnly": true,
"title": "Count",
"type": "integer"
},
"data": {
"items": {
"description": "Lightweight response schema used by the list endpoint. attributes: image_id: public-facing 24-char Mongodb objectid hex string. name: user-provided image name. description: optional description. latest_version: highest version number currently registered. latest_status: build status of the latest version. created_at: row creation timestamp. updated_at: last modification timestamp.",
"properties": {
"createdAt": {
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"id": {
"maxLength": 24,
"minLength": 24,
"pattern": "^[0-9a-fA-F]{24}$",
"title": "Id",
"type": "string"
},
"latestStatus": {
"description": "Build status of a pipeline image version.",
"enum": [
"CREATING",
"READY",
"ERROR"
],
"title": "PipelineImageStatus",
"type": "string"
},
"latestVersion": {
"title": "Latestversion",
"type": "integer"
},
"name": {
"title": "Name",
"type": "string"
},
"updatedAt": {
"format": "date-time",
"title": "Updatedat",
"type": "string"
}
},
"required": [
"id",
"name",
"latestVersion",
"latestStatus",
"createdAt",
"updatedAt"
],
"title": "PipelineImageSummaryResponse",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
},
"totalCount": {
"title": "Totalcount",
"type": "integer"
}
},
"required": [
"data",
"totalCount",
"count"
],
"title": "DataPage[PipelineImageSummaryResponse]",
"type": "object"
}
DataPage[PipelineImageSummaryResponse]
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer | true | none | |
| data | [PipelineImageSummaryResponse] | true | [Lightweight response schema used by the list endpoint. attributes: image_id: public-facing 24-char Mongodb objectid hex string. name: user-provided image name. description: optional description. latest_version: highest version number currently registered. latest_status: build status of the latest version. created_at: row creation timestamp. updated_at: last modification timestamp.] | |
| next | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| previous | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| totalCount | integer | true | none |
HTTPValidationError
{
"properties": {
"detail": {
"items": {
"properties": {
"ctx": {
"title": "Context",
"type": "object"
},
"input": {
"title": "Input"
},
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"title": "Location",
"type": "array"
},
"msg": {
"title": "Message",
"type": "string"
},
"type": {
"title": "Error Type",
"type": "string"
}
},
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError",
"type": "object"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
HTTPValidationError
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| detail | [ValidationError] | false | none |
PipelineImageCreateRequest
{
"description": "Request body for ``post /pipelines/images``. carries the canonical image definition plus an optional human-readable description. the description is stored on the parent ``pipelineimage`` row, not the version. ``conda`` is accepted but not shown in the openapi schema; use ``packages`` (pip specifiers) and ``pythonversion`` as the primary fields. ``gpu`` is documented but gated by the ``gpu_enabled`` flag (422 when off). ``is_ephemeral`` (wire: ``isephemeral``) marks the built image for automatic cleanup by the image build service (deleted from the registry ~48h after build). defaults to ``false`` so real pipeline images remain durable for the life of the pipeline; acceptance/regression tests set it ``true`` so their throwaway build artifacts are auto-gc'd instead of accumulating in the registry. named to match build-service's own ``is_ephemeral`` build flag. not part of the persisted image definition (a build-time directive, like ``description``), so it does not affect version dedup.",
"properties": {
"description": {
"anyOf": [
{
"maxLength": 2048,
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"gpu": {
"default": false,
"description": "Request gpu support for the built image. a pod-scheduling signal (gpu resource claim + tolerations + affinity applied at dispatch); the image bakes no cuda by default — bring your own gpu wheels. gated by the environment's gpu capacity: when gpu support is not enabled a ``gpu: true`` request is rejected with 422. accepted as the deprecated alias ``nvidia``.",
"title": "Gpu",
"type": "boolean"
},
"name": {
"maxLength": 255,
"minLength": 1,
"title": "Name",
"type": "string"
},
"packages": {
"items": {
"type": "string"
},
"title": "Packages",
"type": "array"
},
"pythonBaseImage": {
"anyOf": [
{
"maxLength": 512,
"type": "string"
},
{
"type": "null"
}
],
"deprecated": true,
"description": "Deprecated — use ``pythonversion``. a bare ``major.minor`` value is folded into ``pythonversion``; a full image reference is accepted but ignored at build time (it would bypass the fips base image).",
"title": "Pythonbaseimage"
},
"pythonVersion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Python interpreter version for the built image, e.g. ``3.11``. selects the DR runtime base-image tag; the venv is built against this interpreter. allowed: 3.10, 3.11, 3.12, 3.13. when omitted, the runtime template's default applies.",
"title": "Pythonversion"
}
},
"required": [
"name"
],
"title": "PipelineImageCreateRequest",
"type": "object"
}
PipelineImageCreateRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | maxLength: 2048 |
none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| gpu | boolean | false | Request gpu support for the built image. a pod-scheduling signal (gpu resource claim + tolerations + affinity applied at dispatch); the image bakes no cuda by default — bring your own gpu wheels. gated by the environment's gpu capacity: when gpu support is not enabled a gpu: true request is rejected with 422. accepted as the deprecated alias nvidia. |
|
| name | string | true | maxLength: 255 minLength: 1 minLength: 1 |
none |
| packages | [string] | false | none | |
| pythonBaseImage | any | false | Deprecated — use pythonversion. a bare major.minor value is folded into pythonversion; a full image reference is accepted but ignored at build time (it would bypass the fips base image). |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | maxLength: 512 |
none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| pythonVersion | any | false | Python interpreter version for the built image, e.g. 3.11. selects the DR runtime base-image tag; the venv is built against this interpreter. allowed: 3.10, 3.11, 3.12, 3.13. when omitted, the runtime template's default applies. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
PipelineImageDefinition
{
"description": "Canonical image definition stored on ``pipelineimageversion``. ``packages`` maps to covalent's ``pip`` kwarg. ``python_base_image`` maps to covalent's ``base_image`` kwarg. ``gpu`` maps to covalent's ``nvidia`` kwarg (a pod-scheduling signal). ``conda`` is supported for power users but not surfaced in the public API schema. persisted as jsonb in ``pipelineimageversion.definition``.",
"properties": {
"conda": {
"anyOf": [
{
"description": "Structured conda specification with explicit channels and dependencies. equivalent to the dict-form ``conda`` kwarg of ``covalent.create_env``: .. code-block:: Python conda={ \"channels\": [\"conda-forge\", \"defaults\"], \"dependencies\": [\"numpy=1.21.*\", \"xarray=0.15.1\"], }.",
"properties": {
"channels": {
"items": {
"type": "string"
},
"title": "Channels",
"type": "array"
},
"dependencies": {
"items": {
"type": "string"
},
"title": "Dependencies",
"type": "array"
}
},
"title": "CondaSpec",
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"title": "Conda"
},
"gpu": {
"default": false,
"description": "Request gpu support for the built image. a pod-scheduling signal (gpu resource claim + tolerations + affinity applied at dispatch); the image bakes no cuda by default — bring your own gpu wheels. gated by the environment's gpu capacity: when gpu support is not enabled a ``gpu: true`` request is rejected with 422. accepted as the deprecated alias ``nvidia``.",
"title": "Gpu",
"type": "boolean"
},
"name": {
"maxLength": 255,
"minLength": 1,
"title": "Name",
"type": "string"
},
"packages": {
"items": {
"type": "string"
},
"title": "Packages",
"type": "array"
},
"pythonBaseImage": {
"anyOf": [
{
"maxLength": 512,
"type": "string"
},
{
"type": "null"
}
],
"deprecated": true,
"description": "Deprecated — use ``pythonversion``. a bare ``major.minor`` value is folded into ``pythonversion``; a full image reference is accepted but ignored at build time (it would bypass the fips base image).",
"title": "Pythonbaseimage"
},
"pythonVersion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Python interpreter version for the built image, e.g. ``3.11``. selects the DR runtime base-image tag; the venv is built against this interpreter. allowed: 3.10, 3.11, 3.12, 3.13. when omitted, the runtime template's default applies.",
"title": "Pythonversion"
}
},
"required": [
"name"
],
"title": "PipelineImageDefinition",
"type": "object"
}
PipelineImageDefinition
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| conda | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | CondaSpec | false | Structured conda specification with explicit channels and dependencies. equivalent to the dict-form conda kwarg of covalent.create_env: .. code-block:: Python conda={ "channels": ["conda-forge", "defaults"], "dependencies": ["numpy=1.21.*", "xarray=0.15.1"], }. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [string] | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| gpu | boolean | false | Request gpu support for the built image. a pod-scheduling signal (gpu resource claim + tolerations + affinity applied at dispatch); the image bakes no cuda by default — bring your own gpu wheels. gated by the environment's gpu capacity: when gpu support is not enabled a gpu: true request is rejected with 422. accepted as the deprecated alias nvidia. |
|
| name | string | true | maxLength: 255 minLength: 1 minLength: 1 |
none |
| packages | [string] | false | none | |
| pythonBaseImage | any | false | Deprecated — use pythonversion. a bare major.minor value is folded into pythonversion; a full image reference is accepted but ignored at build time (it would bypass the fips base image). |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | maxLength: 512 |
none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| pythonVersion | any | false | Python interpreter version for the built image, e.g. 3.11. selects the DR runtime base-image tag; the venv is built against this interpreter. allowed: 3.10, 3.11, 3.12, 3.13. when omitted, the runtime template's default applies. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
PipelineImageLogsResponse
{
"description": "Response schema for image build logs. attributes: logs: full raw build output as a utf-8 decoded string.",
"properties": {
"logs": {
"title": "Logs",
"type": "string"
}
},
"required": [
"logs"
],
"title": "PipelineImageLogsResponse",
"type": "object"
}
PipelineImageLogsResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| logs | string | true | none |
PipelineImageResponse
{
"description": "Detailed response schema for a pipeline image. attributes: image_id: public-facing 24-char Mongodb objectid hex string. name: user-provided image name. description: optional description. latest_version: highest version number currently registered. versions: all versions ordered newest-first. created_at: row creation timestamp. updated_at: last modification timestamp.",
"properties": {
"createdAt": {
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"id": {
"maxLength": 24,
"minLength": 24,
"pattern": "^[0-9a-fA-F]{24}$",
"title": "Id",
"type": "string"
},
"latestVersion": {
"title": "Latestversion",
"type": "integer"
},
"name": {
"title": "Name",
"type": "string"
},
"updatedAt": {
"format": "date-time",
"title": "Updatedat",
"type": "string"
},
"versions": {
"items": {
"description": "Response schema for a single image version. carries the full ``definition`` round-trip so clients see exactly what was sent at create time. ``status`` / ``error_detail`` reflect the build outcome. ``image_uri`` is populated once an ibs-direct build completes successfully.",
"properties": {
"createdAt": {
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"definition": {
"description": "Canonical image definition stored on ``pipelineimageversion``. ``packages`` maps to covalent's ``pip`` kwarg. ``python_base_image`` maps to covalent's ``base_image`` kwarg. ``gpu`` maps to covalent's ``nvidia`` kwarg (a pod-scheduling signal). ``conda`` is supported for power users but not surfaced in the public API schema. persisted as jsonb in ``pipelineimageversion.definition``.",
"properties": {
"conda": {
"anyOf": [
{
"description": "Structured conda specification with explicit channels and dependencies. equivalent to the dict-form ``conda`` kwarg of ``covalent.create_env``: .. code-block:: Python conda={ \"channels\": [\"conda-forge\", \"defaults\"], \"dependencies\": [\"numpy=1.21.*\", \"xarray=0.15.1\"], }.",
"properties": {
"channels": {
"items": {
"type": "string"
},
"title": "Channels",
"type": "array"
},
"dependencies": {
"items": {
"type": "string"
},
"title": "Dependencies",
"type": "array"
}
},
"title": "CondaSpec",
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"title": "Conda"
},
"gpu": {
"default": false,
"description": "Request gpu support for the built image. a pod-scheduling signal (gpu resource claim + tolerations + affinity applied at dispatch); the image bakes no cuda by default — bring your own gpu wheels. gated by the environment's gpu capacity: when gpu support is not enabled a ``gpu: true`` request is rejected with 422. accepted as the deprecated alias ``nvidia``.",
"title": "Gpu",
"type": "boolean"
},
"name": {
"maxLength": 255,
"minLength": 1,
"title": "Name",
"type": "string"
},
"packages": {
"items": {
"type": "string"
},
"title": "Packages",
"type": "array"
},
"pythonBaseImage": {
"anyOf": [
{
"maxLength": 512,
"type": "string"
},
{
"type": "null"
}
],
"deprecated": true,
"description": "Deprecated — use ``pythonversion``. a bare ``major.minor`` value is folded into ``pythonversion``; a full image reference is accepted but ignored at build time (it would bypass the fips base image).",
"title": "Pythonbaseimage"
},
"pythonVersion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Python interpreter version for the built image, e.g. ``3.11``. selects the DR runtime base-image tag; the venv is built against this interpreter. allowed: 3.10, 3.11, 3.12, 3.13. when omitted, the runtime template's default applies.",
"title": "Pythonversion"
}
},
"required": [
"name"
],
"title": "PipelineImageDefinition",
"type": "object"
},
"errorDetail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Errordetail"
},
"imageUri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Imageuri"
},
"status": {
"description": "Build status of a pipeline image version.",
"enum": [
"CREATING",
"READY",
"ERROR"
],
"title": "PipelineImageStatus",
"type": "string"
},
"updatedAt": {
"format": "date-time",
"title": "Updatedat",
"type": "string"
},
"version": {
"title": "Version",
"type": "integer"
}
},
"required": [
"version",
"definition",
"status",
"createdAt",
"updatedAt"
],
"title": "PipelineImageVersionResponse",
"type": "object"
},
"title": "Versions",
"type": "array"
}
},
"required": [
"id",
"name",
"latestVersion",
"versions",
"createdAt",
"updatedAt"
],
"title": "PipelineImageResponse",
"type": "object"
}
PipelineImageResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| createdAt | string(date-time) | true | none | |
| description | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | maxLength: 24 minLength: 24 minLength: 24 |
none |
| latestVersion | integer | true | none | |
| name | string | true | none | |
| updatedAt | string(date-time) | true | none | |
| versions | [PipelineImageVersionResponse] | true | [Response schema for a single image version. carries the full definition round-trip so clients see exactly what was sent at create time. status / error_detail reflect the build outcome. image_uri is populated once an ibs-direct build completes successfully.] |
PipelineImageStatus
{
"description": "Build status of a pipeline image version.",
"enum": [
"CREATING",
"READY",
"ERROR"
],
"title": "PipelineImageStatus",
"type": "string"
}
PipelineImageStatus
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| PipelineImageStatus | string | false | Build status of a pipeline image version. |
Enumerated Values¶
| Property | Value |
|---|---|
| PipelineImageStatus | [CREATING, READY, ERROR] |
PipelineImageSummaryResponse
{
"description": "Lightweight response schema used by the list endpoint. attributes: image_id: public-facing 24-char Mongodb objectid hex string. name: user-provided image name. description: optional description. latest_version: highest version number currently registered. latest_status: build status of the latest version. created_at: row creation timestamp. updated_at: last modification timestamp.",
"properties": {
"createdAt": {
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"id": {
"maxLength": 24,
"minLength": 24,
"pattern": "^[0-9a-fA-F]{24}$",
"title": "Id",
"type": "string"
},
"latestStatus": {
"description": "Build status of a pipeline image version.",
"enum": [
"CREATING",
"READY",
"ERROR"
],
"title": "PipelineImageStatus",
"type": "string"
},
"latestVersion": {
"title": "Latestversion",
"type": "integer"
},
"name": {
"title": "Name",
"type": "string"
},
"updatedAt": {
"format": "date-time",
"title": "Updatedat",
"type": "string"
}
},
"required": [
"id",
"name",
"latestVersion",
"latestStatus",
"createdAt",
"updatedAt"
],
"title": "PipelineImageSummaryResponse",
"type": "object"
}
PipelineImageSummaryResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| createdAt | string(date-time) | true | none | |
| description | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | maxLength: 24 minLength: 24 minLength: 24 |
none |
| latestStatus | PipelineImageStatus | true | Build status of a pipeline image version. | |
| latestVersion | integer | true | none | |
| name | string | true | none | |
| updatedAt | string(date-time) | true | none |
PipelineImageUpdateRequest
{
"description": "Request body for ``patch /pipelines/images/{image_id}``. creates a new immutable ``pipelineimageversion`` carrying the full definition supplied here. the previous version is left untouched — pipelines locked against it keep working. replacement semantics: the body is a complete redefinition, not a merge. to \"add a package\" the caller posts the previous definition plus the new entry. ``conda`` is accepted but not shown in the openapi schema. ``gpu`` is documented but gated by the ``gpu_enabled`` flag (422 when off). ``is_ephemeral`` (wire: ``isephemeral``, default ``false``) marks the new version's build for automatic ibs cleanup — see ``pipelineimagecreaterequest``. build-time directive only; not persisted in the definition.",
"properties": {
"gpu": {
"default": false,
"description": "Request gpu support for the built image. a pod-scheduling signal (gpu resource claim + tolerations + affinity applied at dispatch); the image bakes no cuda by default — bring your own gpu wheels. gated by the environment's gpu capacity: when gpu support is not enabled a ``gpu: true`` request is rejected with 422. accepted as the deprecated alias ``nvidia``.",
"title": "Gpu",
"type": "boolean"
},
"name": {
"maxLength": 255,
"minLength": 1,
"title": "Name",
"type": "string"
},
"packages": {
"items": {
"type": "string"
},
"title": "Packages",
"type": "array"
},
"pythonBaseImage": {
"anyOf": [
{
"maxLength": 512,
"type": "string"
},
{
"type": "null"
}
],
"deprecated": true,
"description": "Deprecated — use ``pythonversion``. a bare ``major.minor`` value is folded into ``pythonversion``; a full image reference is accepted but ignored at build time (it would bypass the fips base image).",
"title": "Pythonbaseimage"
},
"pythonVersion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Python interpreter version for the built image, e.g. ``3.11``. selects the DR runtime base-image tag; the venv is built against this interpreter. allowed: 3.10, 3.11, 3.12, 3.13. when omitted, the runtime template's default applies.",
"title": "Pythonversion"
}
},
"required": [
"name"
],
"title": "PipelineImageUpdateRequest",
"type": "object"
}
PipelineImageUpdateRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| gpu | boolean | false | Request gpu support for the built image. a pod-scheduling signal (gpu resource claim + tolerations + affinity applied at dispatch); the image bakes no cuda by default — bring your own gpu wheels. gated by the environment's gpu capacity: when gpu support is not enabled a gpu: true request is rejected with 422. accepted as the deprecated alias nvidia. |
|
| name | string | true | maxLength: 255 minLength: 1 minLength: 1 |
none |
| packages | [string] | false | none | |
| pythonBaseImage | any | false | Deprecated — use pythonversion. a bare major.minor value is folded into pythonversion; a full image reference is accepted but ignored at build time (it would bypass the fips base image). |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | maxLength: 512 |
none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| pythonVersion | any | false | Python interpreter version for the built image, e.g. 3.11. selects the DR runtime base-image tag; the venv is built against this interpreter. allowed: 3.10, 3.11, 3.12, 3.13. when omitted, the runtime template's default applies. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
PipelineImageVersionResponse
{
"description": "Response schema for a single image version. carries the full ``definition`` round-trip so clients see exactly what was sent at create time. ``status`` / ``error_detail`` reflect the build outcome. ``image_uri`` is populated once an ibs-direct build completes successfully.",
"properties": {
"createdAt": {
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"definition": {
"description": "Canonical image definition stored on ``pipelineimageversion``. ``packages`` maps to covalent's ``pip`` kwarg. ``python_base_image`` maps to covalent's ``base_image`` kwarg. ``gpu`` maps to covalent's ``nvidia`` kwarg (a pod-scheduling signal). ``conda`` is supported for power users but not surfaced in the public API schema. persisted as jsonb in ``pipelineimageversion.definition``.",
"properties": {
"conda": {
"anyOf": [
{
"description": "Structured conda specification with explicit channels and dependencies. equivalent to the dict-form ``conda`` kwarg of ``covalent.create_env``: .. code-block:: Python conda={ \"channels\": [\"conda-forge\", \"defaults\"], \"dependencies\": [\"numpy=1.21.*\", \"xarray=0.15.1\"], }.",
"properties": {
"channels": {
"items": {
"type": "string"
},
"title": "Channels",
"type": "array"
},
"dependencies": {
"items": {
"type": "string"
},
"title": "Dependencies",
"type": "array"
}
},
"title": "CondaSpec",
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"title": "Conda"
},
"gpu": {
"default": false,
"description": "Request gpu support for the built image. a pod-scheduling signal (gpu resource claim + tolerations + affinity applied at dispatch); the image bakes no cuda by default — bring your own gpu wheels. gated by the environment's gpu capacity: when gpu support is not enabled a ``gpu: true`` request is rejected with 422. accepted as the deprecated alias ``nvidia``.",
"title": "Gpu",
"type": "boolean"
},
"name": {
"maxLength": 255,
"minLength": 1,
"title": "Name",
"type": "string"
},
"packages": {
"items": {
"type": "string"
},
"title": "Packages",
"type": "array"
},
"pythonBaseImage": {
"anyOf": [
{
"maxLength": 512,
"type": "string"
},
{
"type": "null"
}
],
"deprecated": true,
"description": "Deprecated — use ``pythonversion``. a bare ``major.minor`` value is folded into ``pythonversion``; a full image reference is accepted but ignored at build time (it would bypass the fips base image).",
"title": "Pythonbaseimage"
},
"pythonVersion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Python interpreter version for the built image, e.g. ``3.11``. selects the DR runtime base-image tag; the venv is built against this interpreter. allowed: 3.10, 3.11, 3.12, 3.13. when omitted, the runtime template's default applies.",
"title": "Pythonversion"
}
},
"required": [
"name"
],
"title": "PipelineImageDefinition",
"type": "object"
},
"errorDetail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Errordetail"
},
"imageUri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Imageuri"
},
"status": {
"description": "Build status of a pipeline image version.",
"enum": [
"CREATING",
"READY",
"ERROR"
],
"title": "PipelineImageStatus",
"type": "string"
},
"updatedAt": {
"format": "date-time",
"title": "Updatedat",
"type": "string"
},
"version": {
"title": "Version",
"type": "integer"
}
},
"required": [
"version",
"definition",
"status",
"createdAt",
"updatedAt"
],
"title": "PipelineImageVersionResponse",
"type": "object"
}
PipelineImageVersionResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| createdAt | string(date-time) | true | none | |
| definition | PipelineImageDefinition | true | Canonical image definition stored on pipelineimageversion. packages maps to covalent's pip kwarg. python_base_image maps to covalent's base_image kwarg. gpu maps to covalent's nvidia kwarg (a pod-scheduling signal). conda is supported for power users but not surfaced in the public API schema. persisted as jsonb in pipelineimageversion.definition. |
|
| errorDetail | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| imageUri | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| status | PipelineImageStatus | true | Build status of a pipeline image version. | |
| updatedAt | string(date-time) | true | none | |
| version | integer | true | none |
ValidationError
{
"properties": {
"ctx": {
"title": "Context",
"type": "object"
},
"input": {
"title": "Input"
},
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"title": "Location",
"type": "array"
},
"msg": {
"title": "Message",
"type": "string"
},
"type": {
"title": "Error Type",
"type": "string"
}
},
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError",
"type": "object"
}
ValidationError
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ctx | object | false | none | |
| input | any | false | none | |
| loc | [anyOf] | true | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | integer | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| msg | string | true | none | |
| type | string | true | none |