Create a Study

This guide walks through creating a study and populating it with subjects and organs — the core hierarchy you need before assigning slides or recording findings.

1. Create the study

curl -X POST "https://api.dev2.patholytix.com/api/v1/studies" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "studyName": "GLP-2024-001",
    "siteId": "YOUR_SITE_ID",
    "attributes": {
      "sponsor": "Acme Pharma",
      "species": "Rat"
    }
  }'

The response includes a studyId — you'll use this on every subsequent request.

{
  "studyId": "507f1f77bcf86cd799439011",
  "studyName": "GLP-2024-001",
  "siteId": "YOUR_SITE_ID"
}

2. Add subjects

curl -X POST "https://api.dev2.patholytix.com/api/v1/studies/507f1f77bcf86cd799439011/subjects" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "M001",
    "attributes": {
      "sex": "M",
      "doseGroup": "HIGH"
    }
  }'

name is the SUBJID value — it must be unique within the study and cannot be changed after creation.

3. Add organs

curl -X POST "https://api.dev2.patholytix.com/api/v1/studies/507f1f77bcf86cd799439011/organs" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "subjectId": "SUBJECT_ID",
    "name": "Brain",
    "attributes": {
      "weight": "1.42g"
    }
  }'

name is the MISPEC value — it must be unique within the subject and cannot be changed after creation.

Next steps

• Ingest Images — bring whole-slide images into the study
• Export a Study — download the full study hierarchy as JSON or Excel
• API Reference — full schema for all study endpoints