• 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

​

Errors

The One Codex API communicates errors with standard HTTP status codes with details supplied in JSON objects. The following general pattern applies:

2XX: We received, processed, and accepted a request.

3XX: More action is required in order to complete the request. We use redirects sparingly.

4XX: Client error. Common errors relate to invalid parameters or our inability to find and serve the requested resource.

5XX: Server error. An error occurred on our system(s) while handling the request.

​

HTTP Status Codes

200 success
201 created
202 accepted
204 no_content
302 redirect
304 not_modified
400 bad_request
401 unauthorized
403 forbidden
404 not_found
405 method_not_allowed
409 conflict
412 precondition_failed
429 too_many_requests
500 internal_server_error
503 unavailable

​

Error Response

EXAMPLE ERROR

{
    "message": "The server could not verify that you are authorized to access the URL requested.  You either supplied the wrong credentials...",
    "status": 401
}