List Launchable Pipeline Templates

GET

/v1/pipelines/templates

curl --request GET \
  --url https://example.com/v1/pipelines/templates \
  --header 'X-API-Key: <X-API-Key>'

Templates the caller can launch, each with its launch-form contract.

Authorizations

• ApiKey
• Bearer

Responses

200

Successful Response

Media type application/json

Response List Pipeline Templates V1 Pipelines Templates Get

Array<object>

LaunchableTemplate

object

pipeline_template_id

required

string format: uuid

name

required

string

description

string | null

launch_fields

required

Array<object>

LaunchField

One launch-form field of a template: an exposed port with its JSON schema, derived required-ness, and display metadata.

object

name

required

string

type_name

required

string

schema

object

key

additional properties

any

required

required

boolean

default

nullable

resolve

object

key

additional properties

any

ui

object

key

additional properties

any

Example ^generated

[
  {
    "pipeline_template_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "name": "example",
    "description": "example",
    "launch_fields": [
      {
        "name": "example",
        "type_name": "example",
        "schema": {},
        "required": true,
        "default": "example",
        "resolve": {},
        "ui": {}
      }
    ]
  }
]

401

Invalid or missing API key

Media type application/json

ErrorResponse

Standard error response.

object

detail

required

Error message describing what went wrong

string

Example ^generated

{
  "detail": "example"
}