Skip to main content
GET
/
batch
/
registry
/
pipelines
/
{id}
/
schema
curl https://api.u1.archetypeai.app/v0.5/batch/registry/pipelines/ppl_abc123def456/schema \
  -H "Authorization: Bearer $ATAI_API_KEY"

{
  "id": "ppl_abc123def456",
  "pipeline_key": "machine-state-classification",
  "pipeline_version": "1.1.1",
  "user_schema": {
    "type": "object",
    "properties": {
      "model_type": {
        "type": "string",
        "description": "Omega model variant used to generate embeddings.",
        "enum": ["omega_1_4_base", "omega_1_3_surface", "omega_1_3_power_drive"],
        "default": "omega_1_4_base"
      },
      "batch_size": {
        "type": "integer",
        "description": "Number of windows processed together in a single batch.",
        "default": 32,
        "minimum": 1
      },
      "classifier_config": {
        "type": "object",
        "properties": {
          "n_neighbors": {"type": "integer", "minimum": 3, "default": 5},
          "metric": {"type": "string", "enum": ["euclidean", "cosine", "manhattan"], "default": "euclidean"},
          "weights": {"type": "string", "enum": ["uniform", "distance"], "default": "uniform"},
          "normalize_embeddings": {"type": "boolean", "default": false}
        }
      }
    }
  },
  "config_schema": {},
  "inputs": {
    "worker.inference": {
      "name": "Input files",
      "description": "CSV files for machine-state classification",
      "mode": "plain_file_list",
      "distribute": "scatter",
      "required": true,
      "tracked": true
    },
    "worker.n_shots": {
      "name": "N-Shot example files",
      "description": "Labeled few-shot training files (class declared via input metadata)",
      "mode": "n_shot_file_list",
      "distribute": "replicate",
      "required": true,
      "tracked": false
    }
  },
  "outputs": {
    "worker.results": {
      "name": "Output files",
      "description": "Machine-state classification results"
    }
  }
}

​
Overview

This endpoint returns the configuration schema for a specific pipeline, including the user-facing JSON Schema, full config schema, and input/output port definitions. Use this to understand what parameters a pipeline accepts before creating a job.

​
Request

​
id
string
required
The unique pipeline identifier

​
Response

​
id
string
Pipeline identifier
​
pipeline_key
string
Pipeline key
​
pipeline_version
string
Pipeline version
​
user_schema
object
User-facing JSON Schema describing the configurable parameters for this pipeline (pretty-printed JSON)
​
config_schema
object
Full JSON Schema for the pipeline configuration
​
inputs
object
Input port definitions, each with name, description, mode (plain_file_list or n_shot_file_list), distribute (scatter or replicate), required (bool), and tracked (bool — false for reference/n-shot ports whose inputs land in the terminal reference status).
​
outputs
object
Output port definitions, each with name and description fields
curl https://api.u1.archetypeai.app/v0.5/batch/registry/pipelines/ppl_abc123def456/schema \
  -H "Authorization: Bearer $ATAI_API_KEY"

{
  "id": "ppl_abc123def456",
  "pipeline_key": "machine-state-classification",
  "pipeline_version": "1.1.1",
  "user_schema": {
    "type": "object",
    "properties": {
      "model_type": {
        "type": "string",
        "description": "Omega model variant used to generate embeddings.",
        "enum": ["omega_1_4_base", "omega_1_3_surface", "omega_1_3_power_drive"],
        "default": "omega_1_4_base"
      },
      "batch_size": {
        "type": "integer",
        "description": "Number of windows processed together in a single batch.",
        "default": 32,
        "minimum": 1
      },
      "classifier_config": {
        "type": "object",
        "properties": {
          "n_neighbors": {"type": "integer", "minimum": 3, "default": 5},
          "metric": {"type": "string", "enum": ["euclidean", "cosine", "manhattan"], "default": "euclidean"},
          "weights": {"type": "string", "enum": ["uniform", "distance"], "default": "uniform"},
          "normalize_embeddings": {"type": "boolean", "default": false}
        }
      }
    }
  },
  "config_schema": {},
  "inputs": {
    "worker.inference": {
      "name": "Input files",
      "description": "CSV files for machine-state classification",
      "mode": "plain_file_list",
      "distribute": "scatter",
      "required": true,
      "tracked": true
    },
    "worker.n_shots": {
      "name": "N-Shot example files",
      "description": "Labeled few-shot training files (class declared via input metadata)",
      "mode": "n_shot_file_list",
      "distribute": "replicate",
      "required": true,
      "tracked": false
    }
  },
  "outputs": {
    "worker.results": {
      "name": "Output files",
      "description": "Machine-state classification results"
    }
  }
}
Use the user_schema field to understand what parameters you can pass in the config field when creating a job. This schema describes the user-configurable options for each pipeline component.