Get Inputs Progress Counts - Archetype AI Documentation

curl "https://api.u1.archetypeai.app/v0.5/batch/jobs/job_2abc3def4ghi5jkl6mno7pqr/inputs/progress/counts?port_name=worker.inference" \
  -H "Authorization: Bearer $ATAI_API_KEY"

import requests
import os

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

response = requests.get(
    f"https://api.u1.archetypeai.app/v0.5/batch/jobs/{job_id}/inputs/progress/counts",
    headers={"Authorization": f"Bearer {api_key}"},
    params={"port_name": "worker.inference"},
)

counts = response.json()
print(f"  pending={counts['pending']} processing={counts['processing']} "
      f"completed={counts['completed']} failed={counts['failed']}")

const jobId = 'job_2abc3def4ghi5jkl6mno7pqr';
const params = new URLSearchParams({ port_name: 'worker.inference' });

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

const counts = await response.json();
console.log(`pending=${counts.pending} processing=${counts.processing} completed=${counts.completed} failed=${counts.failed}`);

{
  "job_id": "job_2abc3def4ghi5jkl6mno7pqr",
  "pending": 0,
  "processing": 1,
  "completed": 8,
  "failed": 1,
  "processed_bytes": 40551733,
  "total_bytes": 105332974
}

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

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

GET

batch

jobs

{id}

inputs

progress

counts

curl "https://api.u1.archetypeai.app/v0.5/batch/jobs/job_2abc3def4ghi5jkl6mno7pqr/inputs/progress/counts?port_name=worker.inference" \
  -H "Authorization: Bearer $ATAI_API_KEY"

import requests
import os

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

response = requests.get(
    f"https://api.u1.archetypeai.app/v0.5/batch/jobs/{job_id}/inputs/progress/counts",
    headers={"Authorization": f"Bearer {api_key}"},
    params={"port_name": "worker.inference"},
)

counts = response.json()
print(f"  pending={counts['pending']} processing={counts['processing']} "
      f"completed={counts['completed']} failed={counts['failed']}")

const jobId = 'job_2abc3def4ghi5jkl6mno7pqr';
const params = new URLSearchParams({ port_name: 'worker.inference' });

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

const counts = await response.json();
console.log(`pending=${counts.pending} processing=${counts.processing} completed=${counts.completed} failed=${counts.failed}`);

{
  "job_id": "job_2abc3def4ghi5jkl6mno7pqr",
  "pending": 0,
  "processing": 1,
  "completed": 8,
  "failed": 1,
  "processed_bytes": 40551733,
  "total_bytes": 105332974
}

{
  "code": "NOT_FOUND",
  "message": "Job 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

Returns per-status counts across the job’s tracked (non-reference) inputs. Mirrors the input_progress field embedded on GET /batch/jobs/{id} but lets you scope by port. Cheaper than walking the input list to compute badges.

Request

string

required

The unique job identifier

string

Scope the counts to a single input port (e.g. worker.inference)

Response

string

The job identifier

integer

Inputs not yet picked up by a worker

integer

Present when total_bytes is known and all processing inputs that have reported progress include the input_bytes metric. Otherwise, this property is absent. The value is the sum of the most recent input_bytes reported by all processing inputs, plus the file sizes (num_bytes) of all completed and failed inputs.

integer

The total file size across all tracked inputs, scoped to the port_name filter if provided. Present only when there’s at least one tracked input and all sizes are known. Otherwise, this value is absent.

integer

Inputs currently being processed

integer

Inputs that finished successfully

integer

Inputs that finished with an error

curl "https://api.u1.archetypeai.app/v0.5/batch/jobs/job_2abc3def4ghi5jkl6mno7pqr/inputs/progress/counts?port_name=worker.inference" \
  -H "Authorization: Bearer $ATAI_API_KEY"

import requests
import os

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

response = requests.get(
    f"https://api.u1.archetypeai.app/v0.5/batch/jobs/{job_id}/inputs/progress/counts",
    headers={"Authorization": f"Bearer {api_key}"},
    params={"port_name": "worker.inference"},
)

counts = response.json()
print(f"  pending={counts['pending']} processing={counts['processing']} "
      f"completed={counts['completed']} failed={counts['failed']}")

const jobId = 'job_2abc3def4ghi5jkl6mno7pqr';
const params = new URLSearchParams({ port_name: 'worker.inference' });

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

const counts = await response.json();
console.log(`pending=${counts.pending} processing=${counts.processing} completed=${counts.completed} failed=${counts.failed}`);

{
  "job_id": "job_2abc3def4ghi5jkl6mno7pqr",
  "pending": 0,
  "processing": 1,
  "completed": 8,
  "failed": 1,
  "processed_bytes": 40551733,
  "total_bytes": 105332974
}

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

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

⌘I

​Overview

​Request

​Response

Overview

Request

Response