Get an AI summary for a consultation

GET

/consultation/{consultationId}/ai-summary

curl --request GET \
  --url https://client-api.abi.ai/consultation/8910zyx321cba/ai-summary \
  --header 'Authorization: Bearer <token>'

• Abi Client API

Retrieve the automatically generated AI summary for a consultation. The summary is generated from consultation information and may be incomplete, inaccurate, or omit important context. It is not reviewed or validated by a healthcare professional, is not a clinical assessment or medical advice, and must not be used alone to make diagnosis or treatment decisions.

Authorizations

• bearerAuth

Parameters

Path Parameters

consultationId

required

string

The Abi identifier of the consultation.

Example

8910zyx321cba

Responses

200

Summary processing completed or failed. Inspect status; DONE includes aiSummary, while ERROR includes a processing message.

Media typeapplication/json

AI summary processing result. The response status determines which optional fields are present.

object

status

Summary processing status.

string

Allowed values: PENDING ERROR DONE

message

Processing error message when status is ERROR.

string

aiSummary

Automatically generated consultation summary. This content may be incomplete or inaccurate and is not professional medical advice.

object

consultationId

Consultation identifier used to generate the summary.

string

consultationType

Primary clinical intent or category of the consultation.

string

specialtyCode

Standardized code for the primary medical specialty.

string

specialtyName

Human-readable primary medical specialty.

string

clinicalKeywords

Clinical entities

Array<string>

icd10Codes

ICD-10 diagnosis or symptom codes identified in the consultation.

Array<string>

chiefComplaint

Narrative summary of the patient’s primary symptoms or reason for seeking care.

string

plan

Generated narrative describing advice

string

planActions

Generated high-level follow-up actions.

Array<string>

summary

Single-sentence summary of the consultation and outcome.

string

Examples

Completed AI summary

{
  "status": "DONE",
  "aiSummary": {
    "consultationId": "8910zyx321cba",
    "consultationType": "Symptom checking",
    "specialtyCode": "CAR",
    "specialtyName": "Cardiology",
    "clinicalKeywords": [
      "chest pain",
      "shortness of breath"
    ],
    "icd10Codes": [
      "R07.9",
      "R06.00"
    ],
    "chiefComplaint": "Patient experiencing chest pain.",
    "plan": "Schedule a follow-up appointment with a cardiologist.",
    "planActions": [
      "visit a specialist",
      "diagnostic test"
    ],
    "summary": "The patient reported chest pain and shortness of breath and the doctor recommended further diagnostic tests."
  }
}

Summary processing error

{
  "status": "ERROR",
  "message": "An unexpected error occurred while fetching AI summary"
}

202

Summary generation is still pending. Poll this operation again later.

Media typeapplication/json

AI summary processing result. The response status determines which optional fields are present.

object

status

Summary processing status.

string

Allowed values: PENDING ERROR DONE

message

Processing error message when status is ERROR.

string

aiSummary

Automatically generated consultation summary. This content may be incomplete or inaccurate and is not professional medical advice.

object

consultationId

Consultation identifier used to generate the summary.

string

consultationType

Primary clinical intent or category of the consultation.

string

specialtyCode

Standardized code for the primary medical specialty.

string

specialtyName

Human-readable primary medical specialty.

string

clinicalKeywords

Clinical entities

Array<string>

icd10Codes

ICD-10 diagnosis or symptom codes identified in the consultation.

Array<string>

chiefComplaint

Narrative summary of the patient’s primary symptoms or reason for seeking care.

string

plan

Generated narrative describing advice

string

planActions

Generated high-level follow-up actions.

Array<string>

summary

Single-sentence summary of the consultation and outcome.

string

Example

{
  "status": "PENDING"
}

400

Request could not be completed.

Media typeapplication/json

object

code

Short machine-readable error code.

string

message

Human-readable explanation of the error.

string

Example^generated

{
  "code": "example",
  "message": "example"
}

403

Request could not be completed.

Media typeapplication/json

object

code

Short machine-readable error code.

string

message

Human-readable explanation of the error.

string

Example^generated

{
  "code": "example",
  "message": "example"
}

404

Request could not be completed.

Media typeapplication/json

object

code

Short machine-readable error code.

string

message

Human-readable explanation of the error.

string

Example^generated

{
  "code": "example",
  "message": "example"
}

500

Request could not be completed.

Media typeapplication/json

object

code

Short machine-readable error code.

string

message

Human-readable explanation of the error.

string

Example^generated

{
  "code": "example",
  "message": "example"
}