---
title: "Refresh Patient Dataset"
method: POST
path: "/api/v2/patients/{particle_patient_id}/refresh"
tags: ["Patients"]
---

# Refresh Patient Dataset

`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`

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.

## Path parameters

- `particle_patient_id` string, required

## Request body

- ApiRefreshRequest
  - `dataset` string, required: The dataset to refresh on demand. Supported values: PATIENT_HISTORY, SPECIALTY_SNAPSHOT_CP.

## Response `202`

Accepted

- ApiRefreshResponse
  - `created_at` string: The time the refresh request was accepted, in RFC3339 format.
  - `dataset` string: The dataset being refreshed.
  - `particle_patient_id` string: The particle patient id the refresh was requested for.
  - `refresh_id` string: 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.
  - `status` string: The status of the refresh request. Always "pending" on acceptance; completion is delivered via webhook.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `500`: Internal Server Error

## Changes

- **2026-11-03** `b59a5413a488`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/particlehealth/apis/particle-health-api/changes/api/v2/patients/:particle_patient_id/refresh/post.md)

---

[API](https://skmtc.dev/particlehealth/apis/particle-health-api.md) - [All operations](https://skmtc.dev/particlehealth/apis/particle-health-api/llms.txt) - [OpenAPI document](https://skmtc.dev/particlehealth/apis/particle-health-api/revisions/b59a5413a488?raw)