Heartbeat local execution session
POST
/v1/threads/{threadId}/local-sessions/{localSessionId}/heartbeatHow to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| threadId | path | string | Yes | Thread ID |
| localSessionId | path | string | Yes | Local execution session ID |
Query parameters
None.
Body schema
Content type: application/json · Optional
| Field | Type | Required | Description |
|---|---|---|---|
| metadata | object | No | Free-form metadata object. |
| error | string | No | — |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
200Local execution session heartbeat storedapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| session | object | No | — |
| session.id | string | No | Unique identifier. |
| session.threadId | string | No | Thread ID. |
| session.userId | string | No | User ID. |
| session.deviceId | string | No | — |
| session.workspaceBindingId | string | No | — |
| session.environmentId | string | No | Computer ID. |
| session.status | created | running | completed | failed | cancelled | No | Current lifecycle status. |
| session.metadata | object | No | Free-form metadata object. |
| session.error | string | No | — |
| session.startedAt | string | No | ISO 8601 timestamp. |
| session.lastHeartbeatAt | string | No | — |
| session.completedAt | string | No | ISO 8601 timestamp. |
| session.createdAt | string | No | ISO 8601 timestamp. |
| session.updatedAt | string | No | ISO 8601 timestamp. |
Heartbeat local execution session
Loading...
Response 200
Loading...