# ImmPort Documentation

> ImmPort (immport.org) is the NIAID-funded repository for immunology research data. This documentation explains how to find, download and reuse shared study data, and how researchers submit their own studies. This index currently covers the data submission guide in detail.

Submission in brief: describe the study in ImmPort templates (.xlsx, tab-delimited .txt or .json; current version 3.37), zip them with the files they name (one study per zip, at most 512 MB through the website), validate, upload to a private workspace, then ask the ImmPort Helpdesk (ImmPort_Helpdesk@immport.org) to include the study in a monthly data release. Human subject data must be de-identified.

## Data submission: machine-readable

- [submission-data.json](https://docs.immport.org/data/submission/agent/submission-data.json): templates, per-assay upload workflows with same-package groups, loading order, rules R-01 to R-24, error messages E-01 to E-33 with fixes
- [templates.json](https://downloads.immport.org/data/upload/templates/templates.json): every column of every template (required flags, types, lengths, lookup tables, JSON attributes)
- [lkTables.json](https://downloads.immport.org/data/upload/templates/lkTables.json): allowed values for controlled vocabulary fields
- [Agent skill (zip)](https://docs.immport.org/data/submission/agent/immport-data-submission-skill.zip): SKILL.md package for AI assistants that help prepare submissions

## Data submission: guide

- [Overview](https://docs.immport.org/data/submission/): the five steps and key concepts
- [Account and Workspace](https://docs.immport.org/data/submission/01-getting-started/account-and-workspace/): accounts, workspace requests, Administrator/Submitter/Viewer roles
- [Register Your Study](https://docs.immport.org/data/submission/01-getting-started/register-your-study/): Study Registration Wizard vs Basic Study Design template
- [Template Finder](https://docs.immport.org/data/submission/02-templates/template-finder/): interactive checklist builder
- [Upload Order and Dependencies](https://docs.immport.org/data/submission/02-templates/upload-order/): which templates refer to which, same-package vs separate uploads
- [Assay Workflows](https://docs.immport.org/data/submission/02-templates/assay-workflows/): upload sequence for each of 18 assay types
- [Template Catalog](https://docs.immport.org/data/submission/02-templates/template-catalog/): all 66 templates with downloads
- [JSON Templates](https://docs.immport.org/data/submission/02-templates/json-templates/): submitting templates as JSON Schema documents
- [Sharing Subjects Across Studies](https://docs.immport.org/data/submission/02-templates/subject-sharing-across-studies/): reuse subjects with study_design_edit / arm_2_subject
- [Validate and Upload](https://docs.immport.org/data/submission/03-validation/validate-and-upload/): package checklist, Validator, upload, status, data release
- [Troubleshooting Errors](https://docs.immport.org/data/submission/03-validation/troubleshooting-errors/): error message, cause, example, fix
- [Rules at a Glance](https://docs.immport.org/data/submission/rules-at-a-glance/): every hard rule with a stable ID
- [Data Standards and De-identification](https://docs.immport.org/data/submission/04-standards-and-compliance/data-standards-and-ontologies/)
- [Automate with the API](https://docs.immport.org/data/submission/05-api-reference/automate-with-the-api/): upload, validate, poll, reports; S3 large-file uploads

## Data submission: reference

- [Template field documentation](https://docs.immport.org/data/submission/02-templates/templatedocumentation/Introduction/): one page per template and lookup table
- [Validation Rules](https://docs.immport.org/data/submission/03-validation/validation-rules/): what each validation rule type checks
- [Data Upload API](https://docs.immport.org/apidocumentation/datasubmissionapi/datauploadapi/): official endpoint reference
- [FAQ](https://docs.immport.org/data/submission/faq/)

## Optional

- [ImmPort MCP server](https://docs.immport.org/mcp/overview/): query released ImmPort data (read-only)
- [Data model](https://docs.immport.org/datamodel/)