health_effects

Get Health Effect by ID

Returns a single health effect with its associated papers

get/api/health_effects/{id}

Request

  • Base URL: https://api.supp.co
  • URL: https://api.supp.co/api/health_effects/{id}
  • Auth: none required

Path parameters

idstring uuid required

ID of the health effect to retrieve

Response

Successful operation

idstring uuid required
supplement_idstring uuid required
health_subgoal_idstring required
statestring nullable required
gradestring nullable required
outcomestring nullable required
impact_magnitudestring nullable required
research_confidencestring nullable required
summarystring nullable required
short_summarystring nullable required

From openai_response; null when there is no AI response.

headlinestring nullable required

From openai_response; null when there is no AI response.

bullet_pointsstring[] nullable required

From openai_response; null when there is no AI response.

Example response

{
  "id": "def0a21f-b81a-4f28-a3be-2c55ddfed52a",
  "supplement_id": "def0a21f-b81a-4f28-a3be-2c55ddfed52a",
  "health_subgoal_id": "joint-support",
  "state": "completed",
  "grade": "A",
  "outcome": "positive",
  "impact_magnitude": "large",
  "research_confidence": "high",
  "papers": [
    {
      "id": "def0a21f-b81a-4f28-a3be-2c55ddfed52a",
      "authors": [
        "Smith, J.",
        "Johnson, A."
      ],
      "doi": "10.1234/example.2023",
      "journal": "Journal of Nutrition",
      "pages": "123-145",
      "primary_author": "Smith, J.",
      "title": "Effects of Vitamin D on Bone Health",
      "year": "2023"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.