SUsuki
/api/v1/patient-summary

Get summary generation status by ID

Changed on

Returns the orchestration job status for the given patient summary ID. Common status values include READY, RUNNING, COMPLETED, FAILED, and ABORTED.

get/api/v1/patient-summary/{patient_summary_id}/status

Request

  • Base URL
    https://sdp.suki.ai
  • URL
    https://sdp.suki.ai/api/v1/patient-summary/{patient_summary_id}/status
  • Auth
    API key in header sdp_suki_token

Path parameters

patient_summary_idstring required

Patient summary identifier.

Headers

sdp_provider_idstring
Example:provider-123

Optional for standard partners.

Required for:

  • Bearer authentication. Use the same provider_id returned by the Login or Register API.
  • Single Auth Token authentication. Include the same provider_id on every request as sdp_provider_id.

Response

Success Response

status'READY' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'ABORTED'

Orchestration job status.

Example response

{
  "status": "RUNNING"
}

Changes