Skip to main content

ComponentListResponse

Response containing list of discovered components.

Returned by the component discovery endpoint.

components object[]required

List of available pipeline components

  • Array [
    • nameName (string)required

    Component identifier (WorkflowTemplate name)

    typeType (string)required

    Component type (e.g., 'ocr', 'chunker', 'embedder')

    versionVersion (string)required

    Component version

    descriptionDescription (string)

    Component description

    Default value:
    parameters object[]

    Configurable parameters for this component

  • Array [
    • nameName (string)required

    Parameter name

    default object

    Default value for the parameter

    anyOf
    string
    descriptionDescription (string)

    Parameter description

    Default value:
  • ]
    • inputs object[]

    Input artifacts consumed by this component

  • Array [
    • nameName (string)required

    Artifact name

    pathPath (string)

    File path or location

    Default value:
    optionalOptional (boolean)

    Whether this artifact is optional

    Default value: false
  • ]
    • outputs object[]

    Output artifacts produced by this component

  • Array [
    • nameName (string)required

    Artifact name

    pathPath (string)

    File path or location

    Default value:
    optionalOptional (boolean)

    Whether this artifact is optional

    Default value: false
  • ]
    • labels object

    Kubernetes labels from WorkflowTemplate

    property name*string
    annotations object

    Kubernetes annotations from WorkflowTemplate

    property name*string
    created_at object

    When this component was deployed to Kubernetes

    anyOf
    string<date-time>
  • ]
    • totalTotal (integer)required

    Total number of components discovered

    timestampstring<date-time>

    When this component list was generated (for cache validation)

    ComponentListResponse
    {
      "components": [
        {
          "annotations": {},
          "description": "OCR processing using Mistral Vision API",
          "inputs": [],
          "labels": {},
          "name": "mistral-ocr-processor-v1",
          "outputs": [],
          "parameters": [],
          "type": "ocr",
          "version": "v1"
        }
      ],
      "timestamp": "2025-01-08T12:00:00Z",
      "total": 1
    }