---
title: "Heartbeat Edit-Session"
method: POST
path: "/documents/document-edit-session-heartbeat/{pofid}"
tags: ["Document AI — DMS"]
---

# Heartbeat Edit-Session

`POST /documents/document-edit-session-heartbeat/{pofid}`

## Request

- Base URL: `https://api.paperoffice.ai/latest`
- URL: `https://api.paperoffice.ai/latest/documents/document-edit-session-heartbeat/{pofid}`
- Auth: HTTP bearer

Keeps a previously acquired edit-session lock alive; the lock expires after 90 seconds without a heartbeat. Call at least every 30 seconds while editing (the app polls every 15 seconds). The same session_token renews the lock even...

## Path parameters

- `pofid` string, required

## Response `200`

Success

- SuccessEnvelope: Success envelope. Payload fields are endpoint-specific (top-level fields, `result`/`job_result` for jobs, `data` on some account endpoints).
  - `status` 'success', required
  - `processing_time` union
    - string
    - number
  - `_billing` object

## Other responses

- `4XX`: Error
- `5XX`: Error

---

[API](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api.md) · [All operations](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/revisions/c6a6228a4509?raw)