Skip to main content
POST
/
v1
/
cohorts
import olira

olira.init(api_key="YOUR_API_KEY")
cohort = olira.create_cohort(name="High-Risk Patients", description="Patients flagged for weekly review")
print(cohort.id)

Cohort(
    id="68582e4a0a0b3c1234567890",
    name="High-Risk Patients",
    description="Patients flagged for weekly review",
    patient_ids=[],
    created_at="2026-06-25T10:00:00Z",
    updated_at="2026-06-25T10:00:00Z",
)

olira.create_cohort(name: str, description: str | None = None) -> Cohort
Requires scope: api:manage-patients Cohorts start empty — use add_patients_to_cohort to enroll patients. Names must be unique per organization.

​
Parameters

​
name
str
required
Display name; unique per organization (1–200 characters).
​
description
str | None
Optional free-text description.

​
Returns

Cohort — Created cohort with Olira-assigned id.
​
id
str
Olira cohort id.
​
name
str
Display name.
​
description
str | None
Optional description.
​
patient_ids
list[str]
Patient ids in this cohort.
​
created_at
str | None
ISO 8601 creation timestamp.
​
updated_at
str | None
ISO 8601 last-updated timestamp.

​
Raises

ExceptionWhen
AuthErrorHTTP 401 or 403 — invalid API key or insufficient OAuth scope for this endpoint.
ValidationErrorHTTP 400, 404, or 422 — malformed JSON, unknown patient, or validation failure (message includes response excerpt).
ServerErrorHTTP 409 (e.g. conflicting external identifier) or repeated 5xx after retries; includes status_code when applicable.
RateLimitErrorHTTP 429 — rate limited; check retry_after (seconds).
NetworkErrorConnection timeout, DNS failure, or read error after retries.
import olira

olira.init(api_key="YOUR_API_KEY")
cohort = olira.create_cohort(name="High-Risk Patients", description="Patients flagged for weekly review")
print(cohort.id)

Cohort(
    id="68582e4a0a0b3c1234567890",
    name="High-Risk Patients",
    description="Patients flagged for weekly review",
    patient_ids=[],
    created_at="2026-06-25T10:00:00Z",
    updated_at="2026-06-25T10:00:00Z",
)