Skip to main content
POST
/
batch
/
jobs
curl -X POST https://api.u1.archetypeai.app/v0.5/batch/jobs \
  -H "Authorization: Bearer $ATAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "image-classification-run",
    "pipeline_type": "batch",
    "pipeline_key": "image-classifier",
    "inputs": {
      "images": [
        {"file_id": "file_abc123"},
        {"file_id": "file_def456"}
      ]
    },
    "parameters": {
      "classifier": {
        "parallelism": 2,
        "config": {
          "model": "resnet50",
          "threshold": 0.8
        }
      }
    }
  }'

{
  "id": "job_2abc3def4ghi5jkl6mno7pqr",
  "org_id": "org_1abc2def3ghi4jkl",
  "name": "image-classification-run",
  "pipeline_type": "batch",
  "pipeline_key": "image-classifier",
  "pipeline_version": "1.2.0",
  "status": "PENDING",
  "parameters": {
    "classifier": {
      "parallelism": 2,
      "config": {
        "model": "resnet50",
        "threshold": 0.8
      }
    }
  },
  "retry_count": 0,
  "preemption_count": 0,
  "queue_position": 3,
  "queue_depth": 5,
  "created_at": "2026-04-14T10:00:00Z",
  "updated_at": "2026-04-14T10:00:00Z",
  "started_at": null,
  "completed_at": null,
  "failed_at": null,
  "cancelled_at": null,
  "error": null
}

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 creates a new job with the specified pipeline configuration and optional input files. The job is placed into the queue and will be processed when resources are available.

​
Request

​
name
string
required
A human-readable name for the job
​
pipeline_type
string
required
The type of pipeline to run. One of: batch, training
​
pipeline_key
string
required
The key identifying the pipeline to use from the registry
​
pipeline_version
string
Specific pipeline version to use. If omitted, the latest version is used.
​
inputs
object
Input files organized by port name. Each key is a port name and the value is an array of input file objects containing:
  • file_id (string, required) — The file ID to use as input
  • metadata (object) — Optional metadata for the input file
​
parameters
object
Pipeline parameters organized by component name. Each value is an object with:
  • parallelism (integer) — Number of parallel workers for this component
  • config (object) — Free-form configuration passed to the container

​
Response

​
id
string
Unique job identifier
​
org_id
string
Organization identifier
​
name
string
Job name
​
pipeline_type
string
Pipeline type (batch or training)
​
pipeline_key
string
Pipeline key
​
pipeline_version
string
Pipeline version used
​
status
string
Initial job status (typically PENDING)
​
parameters
object
Resolved job parameters
​
created_at
string
Creation timestamp in RFC 3339 format
curl -X POST https://api.u1.archetypeai.app/v0.5/batch/jobs \
  -H "Authorization: Bearer $ATAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "image-classification-run",
    "pipeline_type": "batch",
    "pipeline_key": "image-classifier",
    "inputs": {
      "images": [
        {"file_id": "file_abc123"},
        {"file_id": "file_def456"}
      ]
    },
    "parameters": {
      "classifier": {
        "parallelism": 2,
        "config": {
          "model": "resnet50",
          "threshold": 0.8
        }
      }
    }
  }'

{
  "id": "job_2abc3def4ghi5jkl6mno7pqr",
  "org_id": "org_1abc2def3ghi4jkl",
  "name": "image-classification-run",
  "pipeline_type": "batch",
  "pipeline_key": "image-classifier",
  "pipeline_version": "1.2.0",
  "status": "PENDING",
  "parameters": {
    "classifier": {
      "parallelism": 2,
      "config": {
        "model": "resnet50",
        "threshold": 0.8
      }
    }
  },
  "retry_count": 0,
  "preemption_count": 0,
  "queue_position": 3,
  "queue_depth": 5,
  "created_at": "2026-04-14T10:00:00Z",
  "updated_at": "2026-04-14T10:00:00Z",
  "started_at": null,
  "completed_at": null,
  "failed_at": null,
  "cancelled_at": null,
  "error": null
}