Skip to content

List Pipeline Template Catalogue

GET
/v1/pipelines/catalog
curl --request GET \
--url https://junction-api.qualiastudios.dev/v1/pipelines/catalog \
--header 'X-API-Key: <X-API-Key>'

The platform’s public templates and the workspace’s own, with their inputs and outputs, and pinnable for those a template may pin.

Successful Response

Media type application/json
Response List Catalog V1 Pipelines Catalog Get
Array<object>
CatalogTemplate

A template the workspace sees, and whether its templates may pin it.

object
pipeline_template_id
required
string format: uuid
name
required
string
version
required

The latest version; pin any up to it

integer
description
string | null
owner
required
string
Allowed values: system workspace
pinnable
required

False for one that pins others itself: nesting is one level

boolean
inputs

What a node pinning it may expose or fix

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
outputs
Array<object>
TemplateOutput

A port a run of the template answers with, read from one node.

object
name
required
string
from
required

{node, port}

object
key
additional properties
string
Example
[
{
"owner": "system"
}
]

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"
}

Missing capability on the workspace

Media type application/json
ErrorResponse

Standard error response.

object
detail
required

Error message describing what went wrong

string
Example generated
{
"detail": "example"
}