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

{
  "id": "pip_abc123def456",
  "pipeline_key": "image-classifier",
  "pipeline_version": "1.2.0",
  "user_schema": {
    "type": "object",
    "properties": {
      "model": {
        "type": "string",
        "description": "Model architecture to use",
        "enum": ["resnet50", "efficientnet-b0"]
      },
      "threshold": {
        "type": "number",
        "description": "Classification confidence threshold",
        "minimum": 0,
        "maximum": 1,
        "default": 0.5
      }
    }
  },
  "config_schema": {},
  "inputs": {
    "images": {
      "name": "images",
      "description": "Input images to classify",
      "mode": "plain_file_list",
      "distribute": "scatter",
      "required": true
    }
  },
  "outputs": {
    "results": {
      "name": "results",
      "description": "Classification results"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.archetypeai.app/llms.txt

Use this file to discover all available pages before exploring further.

​
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, distribute, and required fields
​
outputs
object
Output port definitions, each with name and description fields
curl https://api.u1.archetypeai.app/v0.5/batch/registry/pipelines/pip_abc123def456/schema \
  -H "Authorization: Bearer $ATAI_API_KEY"

{
  "id": "pip_abc123def456",
  "pipeline_key": "image-classifier",
  "pipeline_version": "1.2.0",
  "user_schema": {
    "type": "object",
    "properties": {
      "model": {
        "type": "string",
        "description": "Model architecture to use",
        "enum": ["resnet50", "efficientnet-b0"]
      },
      "threshold": {
        "type": "number",
        "description": "Classification confidence threshold",
        "minimum": 0,
        "maximum": 1,
        "default": 0.5
      }
    }
  },
  "config_schema": {},
  "inputs": {
    "images": {
      "name": "images",
      "description": "Input images to classify",
      "mode": "plain_file_list",
      "distribute": "scatter",
      "required": true
    }
  },
  "outputs": {
    "results": {
      "name": "results",
      "description": "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.