Skip to main content

Create report

POST 
https://us.api.nabla.com/v1/core/server/reports

Create detailed feedback or report issues directly related to specific API interactions.

Request​

Responses​

The created report id, to be referenced when emailing support.

Authorization: http

name: bearertype: httpscheme: bearer
curl -L 'https://us.api.nabla.com/v1/core/server/reports' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>' \
--data-raw '{
  "rating": 0,
  "feedback": "string",
  "reply_to": "user@example.com",
  "payload": {
    "endpoint": "GENERATE_NOTE",
    "input": {
      "note_locale": "ENGLISH_US",
      "transcript_items": [
        {
          "text": "Also, I’m allergic to peanuts.",
          "speaker_type": "DOCTOR"
        }
      ],
      "note_template": "GENERIC_MULTIPLE_SECTIONS",
      "note_sections_customization": [
        {
          "section_key": "CHIEF_COMPLAINT",
          "custom_instruction": "Include discussion about first symptoms",
          "style": "PARAGRAPHS",
          "level_of_detail": "DEFAULT",
          "split_by_problem": true
        }
      ],
      "previous_note": {
        "title": "Fever and strong headache",
        "sections": [
          {
            "key": "CHIEF_COMPLAINT",
            "title": "Chief complaint",
            "text": "Sleep disorder"
          }
        ]
      },
      "patient_context": "string"
    },
    "output": {
      "note": {
        "title": "Fever and strong headache",
        "sections": [
          {
            "key": "CHIEF_COMPLAINT",
            "title": "Chief complaint",
            "text": "Sleep disorder"
          }
        ]
      }
    },
    "expected_output": {
      "note": {
        "title": "Fever and strong headache",
        "sections": [
          {
            "key": "CHIEF_COMPLAINT",
            "title": "Chief complaint",
            "text": "Sleep disorder"
          }
        ]
      }
    }
  }
}'
Request Collapse all
Base URL
https://us.api.nabla.com/v1/core/server
Auth
Body required
{
  "rating": 0,
  "feedback": "string",
  "reply_to": "user@example.com",
  "payload": {
    "endpoint": "GENERATE_NOTE",
    "input": {
      "note_locale": "ENGLISH_US",
      "transcript_items": [
        {
          "text": "Also, I’m allergic to peanuts.",
          "speaker_type": "DOCTOR"
        }
      ],
      "note_template": "GENERIC_MULTIPLE_SECTIONS",
      "note_sections_customization": [
        {
          "section_key": "CHIEF_COMPLAINT",
          "custom_instruction": "Include discussion about first symptoms",
          "style": "PARAGRAPHS",
          "level_of_detail": "DEFAULT",
          "split_by_problem": true
        }
      ],
      "previous_note": {
        "title": "Fever and strong headache",
        "sections": [
          {
            "key": "CHIEF_COMPLAINT",
            "title": "Chief complaint",
            "text": "Sleep disorder"
          }
        ]
      },
      "patient_context": "string"
    },
    "output": {
      "note": {
        "title": "Fever and strong headache",
        "sections": [
          {
            "key": "CHIEF_COMPLAINT",
            "title": "Chief complaint",
            "text": "Sleep disorder"
          }
        ]
      }
    },
    "expected_output": {
      "note": {
        "title": "Fever and strong headache",
        "sections": [
          {
            "key": "CHIEF_COMPLAINT",
            "title": "Chief complaint",
            "text": "Sleep disorder"
          }
        ]
      }
    }
  }
}
ResponseClear

Click the Send API Request button above and see the response here!