For AI agents: the docs index is at https://selfdecode.readme.io/llms.txt. Append .md to any documentation page URL to get its markdown version.
Jump to Content
SelfDecode
API endpoints
Log InSelfDecode
API endpoints
Log In
API endpoints

Introduction

  • About SelfDecode API
  • Development Guide
    • Environments
    • HTTP Status Codes
    • Debugging
    • Internationalization
    • Pagination, Sorting and Filtering
  • What's new in v3?
    • v2 -> v3 transition guide
    • v1 -> v3 transition guide
  • AI Chatbot Iframe

Authentication

  • Bearer Token Authentication

SelfDecode API

  • Profiles
    • /profile/get
    • /profile/post
    • /profile/{id}/get
    • /profile/{id}/put
    • /profile/{id}/del
  • Orders
    • /dna-kit-job/get
    • /dna-kit-job/post
    • /dna-kit-job/{id}/get
    • /order/get
    • /dna-kit-job/{sample_id}/reprocess-for-wgs/put
    • /dna-kit-job/sample-id/{sample_id}/get
    • /order/post
    • /order/{id}/get
    • /order/shipping-options/post
    • /order/{id}/patch
  • Genome Files
    • Genome File Job API
    • Accepted DNA File Formats for Upload
    • Bulk Uploading
    • /genome-file/get
    • /genome-file-bulk-upload/post
    • /genome-file-bulk-upload/{id}/get
    • /genome-file-job/get
    • /genome-file-job/post
    • /genome-file-job/{id}/get
    • /genome-file/{id}/get
    • /genome-file-job/bulk-upload/post
    • /genome-file/download/profile/{profile_id}/get
    • /genome-file/full-genome-download/profile/{profile_id}/get
    • /genome-file/{id}/del
    • /genome-file/upload-file/post
    • /genome-file/wgs-download/profile/{profile_id}/get
  • Genome File Based Jobs
  • Health Reports
    • Managing Health Reports
      • Fetching Health Reports' Metadata
      • Report Classification
      • Generating Health Reports
      • Composing Health Reports
      • Retrieving Profile Report Statuses and Outcomes
      • Report PDF Configs
      • Prerequisite for Diet & Nutrition and Fitness Reports
    • /composed-profile-report/profile/{profile_id}/report/{report_id}/get
    • /profile-report-outcome/get
    • /composed-report/{id}/get
    • /profile-report-status/get
    • /report-job/get
    • /report-job/post
    • /report-job/{id}/get
    • /report-job/bulk-create/post
    • /report-job/generate-all/post
    • /report-job/profile/{profile_id}/report/{report_id}/get
    • /report-job/regenerate/post
    • /report-job/regenerate/bulk-create/post
    • /report-job/regenerate/regenerate-all/post
    • /report-job/upload-file/post
    • /report-summary/get
    • /report/{id}/get
  • Recommendations
    • /recommendation/get
    • /recommendation-id/get
    • /recommendation-summary/get
  • Ancestry Reports
    • Managing Ancestry Reports
    • Population Codes
    • MTH Haplogroups
    • /ancestry-job/get
    • /ancestry-job/post
    • /ancestry-job/{id}/get
    • /composed-ancestry/profile/{id}/get
    • /composed-mtdna/profile/{id}/get
  • PGx Report
    • Managing PGx Reports
    • /composed-pgx/profile/{id}/get
    • /pgx-job/get
    • /pgx-job/post
    • /pgx-job/{id}/get
  • PDFs
    • Acquiring PDFs
    • PDF Configurations
  • Longevity Reports
    • Managing Longevity Reports
    • /composed-longevity-screener/profile/{id}/get
    • /longevity-screener-job/get
    • /longevity-screener-job/post
    • /longevity-screener-job/{id}/get
  • Labs
    • Managing Lab Results
    • Managing Lab PDFs
      • Lab PDF Configs
    • Labs OCR (Beta)
    • /composed-marker-result/get
    • /discrete-result/{id}/put
    • /discrete-result/{id}/patch
    • /discrete-result/async-bulk-create/post
    • /discrete-result/bulk-create/post
    • /discrete-result/bulk-delete/post
    • /lab-ocr-job/get
    • /lab-ocr-job/post
    • /lab-ocr-job/{id}/get
    • /lab-ocr-job/upload-file/post
    • /lab-pdf-job/get
    • /lab-pdf-job/post
    • /lab-pdf-job/{id}/get
    • /marker-summary/get
    • /numeric-result/{id}/put
    • /numeric-result/{id}/patch
    • /numeric-result/async-bulk-create/post
    • /numeric-result/bulk-create/post
    • /numeric-result/bulk-delete/post
    • /result/get
  • Webhooks
    • Webhooks Guide
    • Supported Webhooks' Triggers and Payloads
    • Notification Patterns
    • /user-webhook/get
    • /user-webhook/post
    • /user-webhook/{id}/get
    • /user-webhook/{id}/put
    • /user-webhook/{id}/patch
    • /user-webhook/{id}/del
    • /user-webhook/{id}/recover/put
    • /user-webhook/{id}/reset-secret/put
  • Intake Forms & Lifestyle Assessments
    • Lifestyle Analyzer API
    • Retrieving, Attempting and Reviewing an Intake Form
    • Managing Intake Forms
    • Attempting Questionnaires
    • Answering Questions
    • /answer/get
    • /composed-profile-lifestyle-assessment/profile/{profile_id}/lifestyle-assessment/{lifestyle_assessment_id}/get
    • /answer/post
    • /intake-form/get
    • /intake-form/post
    • /intake-form/{intake_form_id}/question/post
    • /intake-form/{intake_form_id}/question/{id}/put
    • /intake-form/{intake_form_id}/question/{id}/patch
    • /intake-form/{intake_form_id}/question/{id}/del
    • /intake-form/{intake_form_id}/question/{id}/delete-option/{option_id}/del
    • /intake-form/{id}/get
    • /intake-form/{id}/put
    • /intake-form/{id}/patch
    • /intake-form/{id}/reorder-questions/put
    • /lifestyle-assessment-summary/get
    • /lifestyle-assessment/{id}/get
    • /profile-lifestyle-assessment-summary/get
    • /questionnaire-status/profile/{profile_id}/questionnaire/{questionnaire_id}/get
  • BioChemistry
    • Retrieve Composed Report Details
    • /bio-chemistry-job/get
    • /bio-chemistry-job/post
    • /bio-chemistry-job/{id}/get
    • /composed-bio-chemistry-report/{id}/get
  • Carrier Status
    • Managing Carrier Status Reports
    • /carrier-status-job/get
    • /carrier-status-job/post
    • /carrier-status-job/{id}/get
    • /carrier-status-report-summary/get
    • /composed-carrier-status/profile/{id}/get
    • /composed-carrier-status/profile/{profile_id}/report/{id}/get
  • Blogs
    • Get Blogs
    • /article-summary/get
    • /article/{slug}/get
  • Genes
    • Get Genes, SNPs and Genotypes
      • Understanding Genetics
      • Gene Detail Page
      • SNP Detail Page
    • /genotype/get
    • /open-target-gene/get
    • /open-target-snp/get
    • /open-target-snp-summary/get
  • Health Overview Reports
    • /health-overview-job/get
    • /health-overview-job/post
    • /health-overview-job/{id}/get
  • Clinical Overview Reports
    • Managing Clinical Overview Reports
    • /clinical-overview-job/get
    • /clinical-overview-job/post
    • /clinical-overview-job/{id}/get
  • Action Plan Reports
    • /action-plan-job/get
    • /action-plan-job/post
    • /action-plan-job/{id}/get
  • Results Ready
    • /results-ready-job/get
    • /results-ready-job/{id}/get
  • Diet
    • High-level Sequence Diagrams
    • Listing Meals
    • Creating and Updating a Meal Plan
    • Retrieving a Composed Meal Plan
    • Optimal Diet
    • /composed-diet/profile/{profile_id}/get
    • /composed-meal-plan/profile/{profile_id}/get
    • /meal/get
    • /profile-daily-meal-plan/post
    • /profile-daily-meal-plan/profile/{profile_id}/day/{day}/put
  • Custom SNP Lists
    • /snp-file-job/get
    • /snp-file-job/post
    • /snp-file-job/{id}/get
  • Sub Users
    • /sub-user/get
    • /sub-user/post
    • /sub-user/{id}/get
    • /sub-user/{id}/put
    • /sub-user/{id}/del
    • /sub-user/{id}/issue-iframe-handoff/post
    • /sub-user/{id}/issue-token/post
    • /sub-user/{id}/issue-mcp-token/post
Powered by 

Managing Health Reports

  • Fetching Health Reports' Metadata
  • Report Classification
  • Generating Health Reports
  • Composing Health Reports
  • Retrieving Profile Report Statuses and Outcomes
  • Report PDF Configs
  • Prerequisite for Diet & Nutrition and Fitness Report PDFs

Updated over 1 year ago


Did this page help you?

Updated over 1 year ago


Did this page help you?