List Jobs | Captain Docs

import requests
BASE_URL = "https://api.runcaptain.com"
API_KEY = "your_api_key"
headers = {
    "Authorization": f"Bearer {API_KEY}",
}
response = requests.get(
    f"{BASE_URL}/v2/jobs",
    headers=headers,
    params={
        "status": "running",
        "limit": 50,
        "offset": 0
    },
    timeout=30.0
)
if response.status_code == 200:
    data = response.json()
    print(f"{data['total_count']} job(s)")
    for job in data.get("jobs") or []:
        print(f"  {job['job_id']} -> {job['status']} "
              f"(collection={job.get('collection_name')})")
else:
    print(f"Error: {response.status_code}")

{
  "jobs": [
    {
      "job_id": "job_s3_abc123",
      "status": "running",
      "job_type": "index_s3_directory",
      "storage_type": "s3",
      "collection_name": "my_documents",
      "environment": "production",
      "job_name": "Index s3://acme-docs/reports",
      "created_at": "2025-01-20T08:15:00Z",
      "finished_at": null,
      "files_total": 120,
      "files_indexed": 47,
      "files_failed": 0,
      "files_skipped": 3,
      "error": null
    }
  ],
  "total_count": 1,
  "limit": 50,
  "offset": 0
}

List your indexing jobs, newest first. Filter by status or collection, and page through results with limit and offset. Use this to see what’s currently running, review recent jobs, and check how many files each indexed. For the full detail of a single job, use GET /v2/jobs/{job_id}.

Query parameters

statusenum or nullOptional

Filter by job status.

collectionstring or nullOptional

Filter by collection name.

limitintegerOptional1-200Defaults to 50

Jobs per page.

offsetintegerOptional>=0Defaults to 0

Pagination offset.

Response

Successful Response

jobslist of objects

total_countinteger

limitinteger

offsetinteger

Errors

400

Bad Request Error

401

Unauthorized Error

Headers

Query parameters

Response

Errors