{"message":"Welcome to API v1","version":"v1","description":"Comprehensive RESTful API for microbiome data access and analysis","features":["Complete metadata access for projects and samples","Multi-dimensional statistical analysis","Taxonomic data from Silva 138.2 and Greengenes2 2024.09","Abundance data at multiple taxonomic levels","Geographic and phenotypic distribution analysis","System and body site categorization","Real-time data quality assessment"],"endpoints":{"health":{"path":"/api/v1/health","method":"GET","description":"Health check endpoint for API status and database connectivity"},"phenotypes":{"path":"/api/v1/phenotypes","method":"GET","description":"Phenotype API introduction and endpoints overview"},"projects":{"path":"/api/v1/projects","method":"GET","description":"Project API introduction and endpoints overview"},"samples":{"path":"/api/v1/samples","method":"GET","description":"Sample API introduction and endpoints overview"},"countries":{"path":"/api/v1/countries","method":"GET","description":"Country API introduction and endpoints overview"},"bodySites":{"path":"/api/v1/bodysites","method":"GET","description":"Body site API introduction and endpoints overview"},"systems":{"path":"/api/v1/systems","method":"GET","description":"System API introduction and endpoints overview"},"taxa":{"path":"/api/v1/taxa","method":"GET","description":"Taxonomic data API introduction and endpoints overview"},"abundances":{"path":"/api/v1/abundances","method":"GET","description":"Abundance data API introduction and endpoints overview"},"metadatas":{"path":"/api/v1/metadatas","method":"GET","description":"Metadata API introduction and endpoints overview"},"stats":{"path":"/api/v1/stats","method":"GET","description":"Comprehensive database statistics and overview"}},"dataCategories":{"metadata":{"description":"Project and sample metadata access","endpoints":["/api/v1/metadatas/project (POST)","/api/v1/metadatas/sample (POST)"]},"phenotypes":{"description":"Phenotype information and analysis","endpoints":["/api/v1/phenotypes/list","/api/v1/phenotypes/:id/project","/api/v1/phenotypes/:id/sample","/api/v1/phenotypes/:id/stats"]},"projects":{"description":"Project information and analysis","endpoints":["/api/v1/projects/list","/api/v1/projects/:projectAccession/sample","/api/v1/projects/:projectAccession/stats"]},"samples":{"description":"Sample information and analysis","endpoints":["/api/v1/samples/list","/api/v1/samples/:sampleRun/project","/api/v1/samples/:sampleRun/stats"]},"countries":{"description":"Geographic data and analysis","endpoints":["/api/v1/countries/list","/api/v1/countries/:id/project","/api/v1/countries/:id/sample","/api/v1/countries/:id/stats"]},"bodySites":{"description":"Body site categorization and analysis","endpoints":["/api/v1/bodysites/list","/api/v1/bodysites/:id/system","/api/v1/bodysites/:id/stats"]},"systems":{"description":"Biological system categorization and analysis","endpoints":["/api/v1/systems/list","/api/v1/systems/:shortName/project","/api/v1/systems/:shortName/sample","/api/v1/systems/:shortName/stats"]},"taxonomy":{"description":"Taxonomic data from multiple databases","endpoints":["/api/v1/taxa/:db/list","/api/v1/taxa/:db/:id/project","/api/v1/taxa/:db/:id/sample","/api/v1/taxa/:db/:id/stats","/api/v1/taxa/:db/:id/parent","/api/v1/taxa/:db/:id/children"],"supportedDatabases":["gg","silva"],"supportedRanks":["phylum","class","order","family","genus","species"]},"abundance":{"description":"Abundance data at multiple taxonomic levels","endpoints":["/api/v1/abundances/project/:db/:rank/:type (POST)","/api/v1/abundances/sample/:db/:rank/:type (POST)","/api/v1/abundances/cache/:db/:rank/:type"],"supportedDatabases":["gg","silva"],"supportedRanks":["phylum","class","order","family","genus","species"],"supportedTypes":["absolute","relative"]}},"responseFormat":{"success":"Boolean indicating request success","data":"Requested data or null if error","count":"Number of items returned (for list endpoints)","message":"Human-readable response message","error":"Error details (only present on failure)"},"namingConventions":{"description":"All response fields use camelCase naming","examples":{"projectAccession":"Project accession ID","sampleCount":"Number of samples","bodySiteId":"Body site identifier","phenotypeId":"Phenotype identifier"}},"rateLimiting":"No rate limiting currently applied. However, please be aware that the server may be overloaded if too many requests are made simultaneously.","authentication":"No authentication required."}