List batch jobs

GET/lang2fhir/batch

Returns a page of the instance's batch jobs, newest first, without per-job counts. Jobs are shared across the instance's credentials, so this lists every batch job on the instance, not just the calling credential's.

RequiresBearerauthentication

Query parameters

cursorstringoptional

Opaque pagination cursor from a previous page's next_cursor.

limitintegeroptionaldefault 20

Page size. Defaults to 20; values above 100 are clamped to 100.

Returns

A page of batch jobs

Response fields

jobsobject[]required

job_idstringrequired

Server-assigned job identifier.

request_idstringoptional

The idempotency token supplied at create, if any.

statusstringrequired

Job status. completed means every item has finished — some may have failed, so check counts for the split. failed is a whole-job failure (the job could not run at all), distinct from individual item failures, which never fail the job. canceled is a caller-requested cancellation via POST /lang2fhir/batch/{job_id}/cancel; like the other terminal states it keeps any results already produced readable for the retention window.

pendingprocessingcompletedfailedcanceled

finalizedbooleanrequired

Whether the job's item set has been sealed.

total_itemsintegerrequired

The sealed item count. It is 0 until the job is finalized, so an upload response always reports 0; poll the job after finalize for the real count.

errorobjectoptional

A whole-job failure. Present only on a failed job.

created_atstring (date-time)required

updated_atstring (date-time)required

completed_atstring (date-time)optional

When the job finished. Absent until then.

expires_atstring (date-time)required

When the job and its stored inputs and results are deleted. Set 7 days out, with the clock restarting when the job reaches completed, failed, or canceled. At expiry the job's request_id is freed for reuse.

next_cursorstringoptional

Cursor for the next page, when has_more is true.

has_morebooleanrequired

Whether more jobs remain beyond this page.

GETRequest

# Get authentication token
PHENOML_TOKEN=$(curl -X POST "https://experiment.app.pheno.ml/v2/auth/token" \
  -u "$PHENOML_CLIENT_ID:$PHENOML_CLIENT_SECRET" \
  | jq -r '.access_token')

curl -X GET "https://experiment.app.pheno.ml/lang2fhir/batch?cursor=example&limit=20" \
  -H "Authorization: Bearer $PHENOML_TOKEN"

200 OKExample Response

{
  "jobs": [
    {
      "job_id": "l2f_batch_6f1d2c3a-8b4e-4f5a-9c7d-0e1f2a3b4c5d",
      "request_id": "submit-2025-09-02-batch-001",
      "status": "pending",
      "finalized": false,
      "total_items": 12,
      "error": {
        "kind": "processing_failed",
        "message": "the item could not be converted"
      },
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z",
      "completed_at": "2024-01-15T09:30:00Z",
      "expires_at": "2024-01-15T09:30:00Z"
    }
  ],
  "next_cursor": "<cursor>",
  "has_more": false
}