Get Pipeline - Archetype AI Documentation

curl https://api.u1.archetypeai.app/v0.5/batch/registry/pipelines/ppl_abc123def456 \
  -H "Authorization: Bearer $ATAI_API_KEY"

import requests
import os

api_key = os.environ.get("ATAI_API_KEY")
pipeline_id = "ppl_abc123def456"

response = requests.get(
    f"https://api.u1.archetypeai.app/v0.5/batch/registry/pipelines/{pipeline_id}",
    headers={"Authorization": f"Bearer {api_key}"}
)

pipeline = response.json()
print(f"Pipeline: {pipeline['name']} ({pipeline['pipeline_key']} v{pipeline['pipeline_version']})")
print(f"Components: {list(pipeline['components'].keys())}")

const pipelineId = 'ppl_abc123def456';

const response = await fetch(`https://api.u1.archetypeai.app/v0.5/batch/registry/pipelines/${pipelineId}`, {
  headers: {
    'Authorization': `Bearer ${process.env.ATAI_API_KEY}`
  }
});

const pipeline = await response.json();
console.log(`Pipeline: ${pipeline.name} (${pipeline.pipeline_key} v${pipeline.pipeline_version})`);
console.log(`Components: ${Object.keys(pipeline.components).join(', ')}`);

{
  "id": "ppl_abc123def456",
  "pipeline_key": "machine-state-classification",
  "pipeline_version": "1.1.1",
  "name": "Machine State Classification",
  "description": "Identify labeled states in time series sensor data",
  "pipeline_type": "batch",
  "components": {
    "worker": "cmp_xyz789"
  },
  "default_config": {
    "worker": {
      "parallelism": 1,
      "config": {
        "model_type": "omega_1_4_base",
        "batch_size": 32,
        "classifier_config": {
          "n_neighbors": 5,
          "metric": "euclidean",
          "weights": "uniform",
          "normalize_embeddings": false
        }
      }
    }
  },
  "config_schema": {},
  "user_config_schema": {},
  "edges": [],
  "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"
    }
  },
  "retry_policy": {},
  "visibility": "platform",
  "org_id": "org_1abc2def3ghi4jkl",
  "status": "published",
  "created_at": "2026-03-01T00:00:00Z",
  "updated_at": "2026-04-01T00:00:00Z"
}

{
  "code": "NOT_FOUND",
  "message": "Pipeline not found",
  "error_uid": "err_abc123"
}

{
  "detail": "Invalid access with key: api_key_not_found"
}

GET

batch

registry

pipelines

{id}

curl https://api.u1.archetypeai.app/v0.5/batch/registry/pipelines/ppl_abc123def456 \
  -H "Authorization: Bearer $ATAI_API_KEY"

import requests
import os

api_key = os.environ.get("ATAI_API_KEY")
pipeline_id = "ppl_abc123def456"

response = requests.get(
    f"https://api.u1.archetypeai.app/v0.5/batch/registry/pipelines/{pipeline_id}",
    headers={"Authorization": f"Bearer {api_key}"}
)

pipeline = response.json()
print(f"Pipeline: {pipeline['name']} ({pipeline['pipeline_key']} v{pipeline['pipeline_version']})")
print(f"Components: {list(pipeline['components'].keys())}")

const pipelineId = 'ppl_abc123def456';

const response = await fetch(`https://api.u1.archetypeai.app/v0.5/batch/registry/pipelines/${pipelineId}`, {
  headers: {
    'Authorization': `Bearer ${process.env.ATAI_API_KEY}`
  }
});

const pipeline = await response.json();
console.log(`Pipeline: ${pipeline.name} (${pipeline.pipeline_key} v${pipeline.pipeline_version})`);
console.log(`Components: ${Object.keys(pipeline.components).join(', ')}`);

{
  "id": "ppl_abc123def456",
  "pipeline_key": "machine-state-classification",
  "pipeline_version": "1.1.1",
  "name": "Machine State Classification",
  "description": "Identify labeled states in time series sensor data",
  "pipeline_type": "batch",
  "components": {
    "worker": "cmp_xyz789"
  },
  "default_config": {
    "worker": {
      "parallelism": 1,
      "config": {
        "model_type": "omega_1_4_base",
        "batch_size": 32,
        "classifier_config": {
          "n_neighbors": 5,
          "metric": "euclidean",
          "weights": "uniform",
          "normalize_embeddings": false
        }
      }
    }
  },
  "config_schema": {},
  "user_config_schema": {},
  "edges": [],
  "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"
    }
  },
  "retry_policy": {},
  "visibility": "platform",
  "org_id": "org_1abc2def3ghi4jkl",
  "status": "published",
  "created_at": "2026-03-01T00:00:00Z",
  "updated_at": "2026-04-01T00:00:00Z"
}

{
  "code": "NOT_FOUND",
  "message": "Pipeline not found",
  "error_uid": "err_abc123"
}

{
  "detail": "Invalid access with key: api_key_not_found"
}

Requires version 1.1.0 or later of the Archetype platform.

Overview

This endpoint returns the full details of a specific pipeline, including its components, configuration schema, input/output port definitions, and graph edges.

Request

string

required

The unique pipeline identifier

Response

string

Unique pipeline identifier

string

Pipeline key

string

Pipeline version

string

Human-readable pipeline name

string

Pipeline description

string

Pipeline type (batch or training)

object

Map of component names to component IDs

object

Default configuration per component, each with parallelism and config fields

object

JSON Schema for the full pipeline configuration

object

User-facing JSON Schema for configurable parameters

array

Pipeline graph edges, each with from, output, to, and input fields describing component connections

object

Input port definitions, each with:

name — Display name
description — Human-readable description
mode — plain_file_list (a simple list of inputs) or n_shot_file_list (labeled few-shot example files where each item carries metadata.class)
distribute — scatter (fan inputs across workers) or replicate (every worker receives the full list)
required — Whether the port must be supplied
tracked — Whether files attached to this port participate in per-input lifecycle tracking (pending → processing → completed/failed). false for reference ports like n-shot examples — those inputs land in the terminal reference status and never transition.

object

Output port definitions, each with name and description fields

object

Retry policy configuration

string

Visibility level: platform (all orgs) or org (owning org only)

string

Owning organization identifier

string

Registry status: draft, published, deactivated, or deleted

string

Creation timestamp

string

Last update timestamp

curl https://api.u1.archetypeai.app/v0.5/batch/registry/pipelines/ppl_abc123def456 \
  -H "Authorization: Bearer $ATAI_API_KEY"

import requests
import os

api_key = os.environ.get("ATAI_API_KEY")
pipeline_id = "ppl_abc123def456"

response = requests.get(
    f"https://api.u1.archetypeai.app/v0.5/batch/registry/pipelines/{pipeline_id}",
    headers={"Authorization": f"Bearer {api_key}"}
)

pipeline = response.json()
print(f"Pipeline: {pipeline['name']} ({pipeline['pipeline_key']} v{pipeline['pipeline_version']})")
print(f"Components: {list(pipeline['components'].keys())}")

const pipelineId = 'ppl_abc123def456';

const response = await fetch(`https://api.u1.archetypeai.app/v0.5/batch/registry/pipelines/${pipelineId}`, {
  headers: {
    'Authorization': `Bearer ${process.env.ATAI_API_KEY}`
  }
});

const pipeline = await response.json();
console.log(`Pipeline: ${pipeline.name} (${pipeline.pipeline_key} v${pipeline.pipeline_version})`);
console.log(`Components: ${Object.keys(pipeline.components).join(', ')}`);

{
  "id": "ppl_abc123def456",
  "pipeline_key": "machine-state-classification",
  "pipeline_version": "1.1.1",
  "name": "Machine State Classification",
  "description": "Identify labeled states in time series sensor data",
  "pipeline_type": "batch",
  "components": {
    "worker": "cmp_xyz789"
  },
  "default_config": {
    "worker": {
      "parallelism": 1,
      "config": {
        "model_type": "omega_1_4_base",
        "batch_size": 32,
        "classifier_config": {
          "n_neighbors": 5,
          "metric": "euclidean",
          "weights": "uniform",
          "normalize_embeddings": false
        }
      }
    }
  },
  "config_schema": {},
  "user_config_schema": {},
  "edges": [],
  "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"
    }
  },
  "retry_policy": {},
  "visibility": "platform",
  "org_id": "org_1abc2def3ghi4jkl",
  "status": "published",
  "created_at": "2026-03-01T00:00:00Z",
  "updated_at": "2026-04-01T00:00:00Z"
}

{
  "code": "NOT_FOUND",
  "message": "Pipeline not found",
  "error_uid": "err_abc123"
}

{
  "detail": "Invalid access with key: api_key_not_found"
}

List Pipelines Get Pipeline Schema

⌘I

​Overview

​Request

​Response

Overview

Request

Response