Create ingestion job

POST

ingestion

jobs

import olira
from olira.models import IngestDocument

olira.init(api_key="YOUR_API_KEY")
job = olira.create_ingestion_job(
    file="patients_and_logs.jsonl",
    idempotency_key="initial-onboarding-2026",
    require_confirmation=True,
)
# Document package (records= + documents=; not file=):
# job = olira.create_ingestion_job(
#     records=[...],
#     documents=[IngestDocument(path="note.pdf", patient_id="MRN-104",
#         log_type="unstructured_report", document_type="clinical_note",
#         timestamp="2026-03-01T10:00:00Z")],
#     idempotency_key="onboarding-docs-2026-q1",
# )

using Olira;

OliraModule.Init(apiKey: "YOUR_API_KEY");
var job = OliraModule.CreateIngestionJob(
    file: "patients_and_logs.jsonl",
    idempotencyKey: "initial-onboarding-2026",
    requireConfirmation: true);
// Document package (records= + documents=; not file=):
// using var client = new OliraClient(apiKey: "YOUR_API_KEY");
// var job = client.CreateIngestionJob(
//     records: [...],
//     documents: [new IngestDocument(
//         path: "note.pdf",
//         patientId: "MRN-104",
//         logType: "unstructured_report",
//         documentType: "clinical_note",
//         timestamp: "2026-03-01T10:00:00Z")],
//     idempotencyKey: "onboarding-docs-2026-q1");

POST /v1/ingestion/jobs
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "s3_key": "…",
  "idempotency_key": "initial-onboarding-2026",
  "require_confirmation": true
}

IngestionJob(
    job_id="ing-job-001",
    status="awaiting_confirmation",
    stage="awaiting_confirmation",
    progress_pct=100.0,
    patients_processed=42,
    logs_processed=1250,
    logs_failed=3,
    documents_total=0,
    error_summary=[...],
)

{
  "error": true,
  "status_code": 401,
  "error_type": "authentication_error",
  "message": "Could not validate credentials",
  "details": [
    {
      "type": "authentication_error",
      "message": "Could not validate credentials"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 403,
  "error_type": "authorization_error",
  "message": "Insufficient OAuth scope for this endpoint",
  "details": [
    {
      "type": "authorization_error",
      "message": "Insufficient OAuth scope for this endpoint"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 404,
  "error_type": "not_found_error",
  "message": "Patient not found",
  "details": [
    {
      "type": "not_found_error",
      "message": "Patient not found"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 422,
  "error_type": "validation_error",
  "message": "Request validation failed (1 error)",
  "details": [
    {
      "type": "missing",
      "message": "Field required",
      "field": "patient_id",
      "location": ["body", "patient_id"],
      "input_value": null
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 429,
  "error_type": "server_error",
  "message": "Rate limit exceeded",
  "details": [
    {
      "type": "rate_limit",
      "message": "Too many requests; retry after backoff"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 500,
  "error_type": "internal_server_error",
  "message": "An internal server error occurred",
  "details": [
    {
      "type": "internal_server_error",
      "message": "An unexpected error occurred while processing your request"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

olira.create_ingestion_job(
    file: str | None = None,
    records: list[IngestRecord] | None = None,
    documents: list[IngestDocument] | None = None,
    idempotency_key: str | None = None,
    require_confirmation: bool = True,
    summary_types: list[str] | None = None,
    max_event_logs: int | None = None,
) -> IngestionJob

OliraModule.CreateIngestionJob(
    string? file = null,
    IReadOnlyList<IngestRecord>? records = null,
    IReadOnlyList<IngestDocument>? documents = null,
    string? idempotencyKey = null,
    bool requireConfirmation = true,
    IReadOnlyList<string>? summaryTypes = null,
    int? maxEventLogs = null,
)  // -> IngestionJob

Requires scope: sdk:historical-ingest Provide file= (JSONL path — SDK uploads to S3 then creates the job), records= (inline list, ≤ 50,000 rows), and/or documents= (PDF/image binaries for a document package). Local validation runs before any network call. Phase 1 runs automatically; by default the job pauses at awaiting_confirmation for review before graph replay. Document packages use POST /v1/ingestion/jobs:begin for multi-PUT uploads — see the resource ingestion guide.

Parameters

str | None

Path to a JSONL file (patient and/or log rows). Max size from org SDK config (default 100 MB). Not combined with documents=.

list[IngestRecord] | None

Inline patient/log records when file= is not used. Combined with documents= for package jobs.

list[IngestDocument] | None

Local PDF/image paths for a document package. SDK allocates upload URLs, PUTs binaries, builds manifest.jsonl with type=document rows, then creates the job.

str | None

Stable job key; prevents duplicate active/completed jobs (409). Reusable after FAILED.

bool

default:"True"

When True (default), pause at awaiting_confirmation before Phase 2 replay.

list[str] | None

View summary_type identifiers to backfill in Phase 2; None = all active org templates.

int | None

Per-patient cap on logs considered during view backfill only (cost control for log-dense patients).

Returns

IngestionJob — Job snapshot including job_id, status, stage, and progress counters.

str

Job identifier for polling and confirm/cancel.

str

e.g. queued, awaiting_confirmation, replaying, completed.

str

Human-readable pipeline stage.

float

0–100 progress estimate.

int

Patients inserted or updated in Phase 1.

int

Logs successfully inserted as STALE rows.

int

Logs rejected during validation/insert.

int

Document binaries in the package (0 for JSONL-only jobs).

int

Documents that completed OCR successfully.

int

Documents that failed OCR.

list[IngestionErrorSummary] | None

Up to 100 sample errors (line, code, message).

Guide: /send-data/historical-backfill. Document packages: /send-data/resource-ingestion.

When documents= is set, the SDK calls POST /v1/ingestion/jobs:begin, PUTs each binary, PUTs manifest.jsonl, then POST /v1/ingestion/jobs.

Raises

Exception	When
`ValidationError`	Client-side JSONL/records/documents validation failed, file exceeds size limit, or documents= used with file= — no job created.
`AuthError`	HTTP 401 or 403 — invalid API key or insufficient OAuth scope for this endpoint.
`ServerError`	HTTP 409 (e.g. conflicting external identifier) or repeated 5xx after retries; includes status_code when applicable.
`RateLimitError`	HTTP 429 — rate limited; check retry_after (seconds).
`NetworkError`	Connection timeout, DNS failure, or read error after retries.

import olira
from olira.models import IngestDocument

olira.init(api_key="YOUR_API_KEY")
job = olira.create_ingestion_job(
    file="patients_and_logs.jsonl",
    idempotency_key="initial-onboarding-2026",
    require_confirmation=True,
)
# Document package (records= + documents=; not file=):
# job = olira.create_ingestion_job(
#     records=[...],
#     documents=[IngestDocument(path="note.pdf", patient_id="MRN-104",
#         log_type="unstructured_report", document_type="clinical_note",
#         timestamp="2026-03-01T10:00:00Z")],
#     idempotency_key="onboarding-docs-2026-q1",
# )

using Olira;

OliraModule.Init(apiKey: "YOUR_API_KEY");
var job = OliraModule.CreateIngestionJob(
    file: "patients_and_logs.jsonl",
    idempotencyKey: "initial-onboarding-2026",
    requireConfirmation: true);
// Document package (records= + documents=; not file=):
// using var client = new OliraClient(apiKey: "YOUR_API_KEY");
// var job = client.CreateIngestionJob(
//     records: [...],
//     documents: [new IngestDocument(
//         path: "note.pdf",
//         patientId: "MRN-104",
//         logType: "unstructured_report",
//         documentType: "clinical_note",
//         timestamp: "2026-03-01T10:00:00Z")],
//     idempotencyKey: "onboarding-docs-2026-q1");

POST /v1/ingestion/jobs
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "s3_key": "…",
  "idempotency_key": "initial-onboarding-2026",
  "require_confirmation": true
}

IngestionJob(
    job_id="ing-job-001",
    status="awaiting_confirmation",
    stage="awaiting_confirmation",
    progress_pct=100.0,
    patients_processed=42,
    logs_processed=1250,
    logs_failed=3,
    documents_total=0,
    error_summary=[...],
)

{
  "error": true,
  "status_code": 401,
  "error_type": "authentication_error",
  "message": "Could not validate credentials",
  "details": [
    {
      "type": "authentication_error",
      "message": "Could not validate credentials"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 403,
  "error_type": "authorization_error",
  "message": "Insufficient OAuth scope for this endpoint",
  "details": [
    {
      "type": "authorization_error",
      "message": "Insufficient OAuth scope for this endpoint"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 404,
  "error_type": "not_found_error",
  "message": "Patient not found",
  "details": [
    {
      "type": "not_found_error",
      "message": "Patient not found"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 422,
  "error_type": "validation_error",
  "message": "Request validation failed (1 error)",
  "details": [
    {
      "type": "missing",
      "message": "Field required",
      "field": "patient_id",
      "location": ["body", "patient_id"],
      "input_value": null
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 429,
  "error_type": "server_error",
  "message": "Rate limit exceeded",
  "details": [
    {
      "type": "rate_limit",
      "message": "Too many requests; retry after backoff"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 500,
  "error_type": "internal_server_error",
  "message": "An internal server error occurred",
  "details": [
    {
      "type": "internal_server_error",
      "message": "An unexpected error occurred while processing your request"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

import olira
from olira.models import IngestDocument

olira.init(api_key="YOUR_API_KEY")
job = olira.create_ingestion_job(
    file="patients_and_logs.jsonl",
    idempotency_key="initial-onboarding-2026",
    require_confirmation=True,
)
# Document package (records= + documents=; not file=):
# job = olira.create_ingestion_job(
#     records=[...],
#     documents=[IngestDocument(path="note.pdf", patient_id="MRN-104",
#         log_type="unstructured_report", document_type="clinical_note",
#         timestamp="2026-03-01T10:00:00Z")],
#     idempotency_key="onboarding-docs-2026-q1",
# )

using Olira;

OliraModule.Init(apiKey: "YOUR_API_KEY");
var job = OliraModule.CreateIngestionJob(
    file: "patients_and_logs.jsonl",
    idempotencyKey: "initial-onboarding-2026",
    requireConfirmation: true);
// Document package (records= + documents=; not file=):
// using var client = new OliraClient(apiKey: "YOUR_API_KEY");
// var job = client.CreateIngestionJob(
//     records: [...],
//     documents: [new IngestDocument(
//         path: "note.pdf",
//         patientId: "MRN-104",
//         logType: "unstructured_report",
//         documentType: "clinical_note",
//         timestamp: "2026-03-01T10:00:00Z")],
//     idempotencyKey: "onboarding-docs-2026-q1");

POST /v1/ingestion/jobs
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "s3_key": "…",
  "idempotency_key": "initial-onboarding-2026",
  "require_confirmation": true
}

IngestionJob(
    job_id="ing-job-001",
    status="awaiting_confirmation",
    stage="awaiting_confirmation",
    progress_pct=100.0,
    patients_processed=42,
    logs_processed=1250,
    logs_failed=3,
    documents_total=0,
    error_summary=[...],
)

{
  "error": true,
  "status_code": 401,
  "error_type": "authentication_error",
  "message": "Could not validate credentials",
  "details": [
    {
      "type": "authentication_error",
      "message": "Could not validate credentials"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 403,
  "error_type": "authorization_error",
  "message": "Insufficient OAuth scope for this endpoint",
  "details": [
    {
      "type": "authorization_error",
      "message": "Insufficient OAuth scope for this endpoint"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 404,
  "error_type": "not_found_error",
  "message": "Patient not found",
  "details": [
    {
      "type": "not_found_error",
      "message": "Patient not found"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 422,
  "error_type": "validation_error",
  "message": "Request validation failed (1 error)",
  "details": [
    {
      "type": "missing",
      "message": "Field required",
      "field": "patient_id",
      "location": ["body", "patient_id"],
      "input_value": null
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 429,
  "error_type": "server_error",
  "message": "Rate limit exceeded",
  "details": [
    {
      "type": "rate_limit",
      "message": "Too many requests; retry after backoff"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 500,
  "error_type": "internal_server_error",
  "message": "An internal server error occurred",
  "details": [
    {
      "type": "internal_server_error",
      "message": "An unexpected error occurred while processing your request"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

​Parameters

​Returns

​Raises

Parameters

Returns

Raises