List Jobs - Archetype AI Documentation

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

import requests
import os

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

response = requests.get(
    "https://api.u1.archetypeai.app/v0.5/batch/jobs",
    headers={"Authorization": f"Bearer {api_key}"},
    params={
        "pipeline_type": "batch",
        "status": "RUNNING",
        "limit": 10
    }
)

data = response.json()
print(f"Total jobs: {data['total']}")
for job in data["jobs"]:
    print(f"  {job['id']}: {job['name']} — {job['status']}")

const params = new URLSearchParams({
  pipeline_type: 'batch',
  status: 'RUNNING',
  limit: '10'
});

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

const data = await response.json();
console.log(`Total jobs: ${data.total}`);
data.jobs.forEach(job => {
  console.log(`  ${job.id}: ${job.name} — ${job.status}`);
});

{
  "total": 42,
  "offset": 0,
  "limit": 10,
  "jobs": [
    {
      "id": "job_2abc3def4ghi5jkl6mno7pqr",
      "org_id": "org_1abc2def3ghi4jkl",
      "name": "tep-classification",
      "pipeline_type": "batch",
      "pipeline_key": "machine-state-classification",
      "pipeline_version": "1.1.1",
      "status": "RUNNING",
      "parameters": {},
      "retry_count": 0,
      "preemption_count": 0,
      "queue_position": null,
      "queue_depth": null,
      "input_progress": {
        "pending": 0,
        "processing": 1,
        "completed": 2,
        "failed": 0,
        "processed_bytes": 40551733,
        "total_bytes": 105332974
      },
      "created_at": "2026-04-14T10:00:00Z",
      "updated_at": "2026-04-14T10:05:00Z",
      "started_at": "2026-04-14T10:02:00Z",
      "completed_at": null,
      "failed_at": null,
      "cancelled_at": null,
      "error": null
    }
  ]
}

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

GET

batch

jobs

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

import requests
import os

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

response = requests.get(
    "https://api.u1.archetypeai.app/v0.5/batch/jobs",
    headers={"Authorization": f"Bearer {api_key}"},
    params={
        "pipeline_type": "batch",
        "status": "RUNNING",
        "limit": 10
    }
)

data = response.json()
print(f"Total jobs: {data['total']}")
for job in data["jobs"]:
    print(f"  {job['id']}: {job['name']} — {job['status']}")

const params = new URLSearchParams({
  pipeline_type: 'batch',
  status: 'RUNNING',
  limit: '10'
});

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

const data = await response.json();
console.log(`Total jobs: ${data.total}`);
data.jobs.forEach(job => {
  console.log(`  ${job.id}: ${job.name} — ${job.status}`);
});

{
  "total": 42,
  "offset": 0,
  "limit": 10,
  "jobs": [
    {
      "id": "job_2abc3def4ghi5jkl6mno7pqr",
      "org_id": "org_1abc2def3ghi4jkl",
      "name": "tep-classification",
      "pipeline_type": "batch",
      "pipeline_key": "machine-state-classification",
      "pipeline_version": "1.1.1",
      "status": "RUNNING",
      "parameters": {},
      "retry_count": 0,
      "preemption_count": 0,
      "queue_position": null,
      "queue_depth": null,
      "input_progress": {
        "pending": 0,
        "processing": 1,
        "completed": 2,
        "failed": 0,
        "processed_bytes": 40551733,
        "total_bytes": 105332974
      },
      "created_at": "2026-04-14T10:00:00Z",
      "updated_at": "2026-04-14T10:05:00Z",
      "started_at": "2026-04-14T10:02:00Z",
      "completed_at": null,
      "failed_at": null,
      "cancelled_at": null,
      "error": null
    }
  ]
}

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

Requires version 1.1.0 or later of the Archetype platform.

Overview

This endpoint returns a paginated list of jobs. You can filter by pipeline type, status, or a free-text search query.

Request

string

Filter jobs by pipeline type (e.g., batch, training)

string

Filter jobs by status (e.g., PENDING, RUNNING, COMPLETED, FAILED, CANCELLED)

string

Optional filter on the job outcome: SUCCESS, PARTIAL, or FAILED. These are AND-combined with the other filters. Only COMPLETED jobs have an outcome, so a non-empty value for this parameter implicitly limits results to completed jobs. v1.1.5+

string

Free-text search query to filter jobs

integer

Number of items to skip for pagination (default: 0)

integer

Maximum number of items to return per page

Response

integer

Total number of jobs matching the filter criteria

integer

Current pagination offset

integer

Maximum number of items returned

array

Array of job objects, each containing:

id — Unique job identifier
org_id — Organization identifier
name — Job name
pipeline_type — Pipeline type (batch or training)
pipeline_key — Pipeline key
pipeline_version — Pipeline version
status — Current job status
outcome — Job outcome (SUCCESS, PARTIAL, or FAILED). Omitted for jobs whose status isn’t COMPLETED v1.1.5+
parameters — Job parameters
retry_count — Number of retries
preemption_count — Number of preemptions
queue_position — Current position in queue (if queued)
queue_depth — Total queue depth (if queued)
input_progress — Per-status counts of tracked inputs (pending, processing, completed, failed, processed_bytes, total_bytes); populated on this list endpoint, null on write-path responses (see the input_progress property returned by the Get Job endpoint)
created_at — Creation timestamp
updated_at — Last update timestamp
started_at — Start timestamp (if started)
completed_at — Completion timestamp (if completed)
failed_at — Failure timestamp (if failed)
cancelled_at — Cancellation timestamp (if cancelled)
error — Error details (if failed)

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

import requests
import os

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

response = requests.get(
    "https://api.u1.archetypeai.app/v0.5/batch/jobs",
    headers={"Authorization": f"Bearer {api_key}"},
    params={
        "pipeline_type": "batch",
        "status": "RUNNING",
        "limit": 10
    }
)

data = response.json()
print(f"Total jobs: {data['total']}")
for job in data["jobs"]:
    print(f"  {job['id']}: {job['name']} — {job['status']}")

const params = new URLSearchParams({
  pipeline_type: 'batch',
  status: 'RUNNING',
  limit: '10'
});

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

const data = await response.json();
console.log(`Total jobs: ${data.total}`);
data.jobs.forEach(job => {
  console.log(`  ${job.id}: ${job.name} — ${job.status}`);
});

{
  "total": 42,
  "offset": 0,
  "limit": 10,
  "jobs": [
    {
      "id": "job_2abc3def4ghi5jkl6mno7pqr",
      "org_id": "org_1abc2def3ghi4jkl",
      "name": "tep-classification",
      "pipeline_type": "batch",
      "pipeline_key": "machine-state-classification",
      "pipeline_version": "1.1.1",
      "status": "RUNNING",
      "parameters": {},
      "retry_count": 0,
      "preemption_count": 0,
      "queue_position": null,
      "queue_depth": null,
      "input_progress": {
        "pending": 0,
        "processing": 1,
        "completed": 2,
        "failed": 0,
        "processed_bytes": 40551733,
        "total_bytes": 105332974
      },
      "created_at": "2026-04-14T10:00:00Z",
      "updated_at": "2026-04-14T10:05:00Z",
      "started_at": "2026-04-14T10:02:00Z",
      "completed_at": null,
      "failed_at": null,
      "cancelled_at": null,
      "error": null
    }
  ]
}

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

Create Job Get Job

⌘I

​Overview

​Request

​Response

Overview

Request

Response