• Getting Started
• Authentication
• API Documentation
• CLI & Client Library (Python)
• Jupyter Notebooks
• Pagination
• Errors

​

Samples

• The Sample Resource

• Retrieve All Samplesget

• Retrieve A Sampleget

• Retrieve Public Samplesget

• Uploading Samples

  • Starting an Uploadpost
  • Confirming an Uploadpost
  • Pre-Uploading Samplespost

• Updating Samplespatch

• Downloading Sequence Datapost

​

Metadata & Tags

• The Metadata Resource
• The Tag Resource
• Retrieve All Metadataget
• Retrieve A Metadata Recordget
• Retrieve All Tagsget
• Retrieve A Tagget
• Updating Metadatapatch

​

Analyses

• The Analysis Resource
• Retrieve All Analysesget
• Retrieve An Analysisget
• Retrieve Analysis Resultsget
• Retrieve Analysis Filesget
• Retrieve Analysis Output File Detailsget
• The Classification Resource
• Retrieve All Classificationsget
• Retrieve A Classificationget
• Classification Resultsget
• Read-Level Resultsget
• The Panel Resource
• Retrieve A Panelget
• Retrieve All Panelsget
• Panel Resultsget
• The Alignment Resource
• Retrieve All Alignmentsget
• Retrieve An Alignmentget

​

Jobs

• The Job Resource
• Retrieve All Jobsget
• Retrieve A Jobget

​

Documents

• The Document Resource

• Retrieve All Documentsget

• Retrieve A Documentget

• Uploading Documents

  • Starting a Document Uploadpost
  • Confirming a Document uploadpost

• Downloading Documentspost

​

Webhooks & Events

• Using Webhooks
• Checking Signatures
• Retrieve All Eventsget
• Retrieve An Eventget

​

Sequencing

• Sequencing Batches

  • Retrieving All Sequencing Batchesget
  • Retrieving a Sequencing Batchget
  • Registering a Sequencing Batchpost
  • Retrieving Samples in a Sequencing Batchget

​

Pagination

The One Codex API follows the basic pagination model of the GitHub API. Pages may be requested using the page and per_page query string arguments. The Link header lists links to the current, previous, next, first, and last pages. The X-Total-Count header contains a count of the total number of items:

HTTP/1.1 200 OK
Link: </api/v1/samples?page=1&per_page=20>; rel="self",
      </api/v1/samples?page=2&per_page=20>; rel="next"
      </api/v1/samples?page=3&per_page=20>; rel="last"
X-Total-Count: 46