PAparticlehealth
Patients

Refresh Patient Dataset

Changed on

Requests on-demand regeneration of an AI output dataset for a patient. Gated by the same feature entitlement as the dataset's automatic trigger. The patient must have a previously completed query. Completion is delivered via the existing dataset webhook.

post/api/v2/patients/{particle_patient_id}/refresh

Request

  • Base URL
    https://sandbox.particlehealth.com
  • URL
    https://sandbox.particlehealth.com/api/v2/patients/{particle_patient_id}/refresh
  • Auth
    API key in header Authorization

Path parameters

particle_patient_idstring required

Particle Patient ID

Request body

datasetstring required

The dataset to refresh on demand. Supported values: PATIENT_HISTORY, SPECIALTY_SNAPSHOT_CP.

Example request

{
  "dataset": "PATIENT_HISTORY"
}

Response

Accepted

created_atstring

The time the refresh request was accepted, in RFC3339 format.

datasetstring

The dataset being refreshed.

particle_patient_idstring

The particle patient id the refresh was requested for.

refresh_idstring

The unique ID for this refresh request. It may not be included on the completion webhook; use it to correlate the request in logs/support.

statusstring

The status of the refresh request. Always "pending" on acceptance; completion is delivered via webhook.

Example response

{
  "created_at": "2026-07-14T17:00:00Z",
  "dataset": "PATIENT_HISTORY",
  "particle_patient_id": "ac82d365-97f9-4111-92fa-3a2b92744b12",
  "refresh_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "pending"
}

Changes