Renew an execution dispatch claim

POST/v1/internal/execution-dispatch/claims/{dispatchId}/heartbeat

How 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
NameLocationTypeRequiredDescription
dispatchIdpathstringYesDurable execution dispatch ID
Query parameters
None.

Body schema

Content type: application/json · Required

FieldTypeRequiredDescription
tokenstringYes
leaseTtlMsintegerNo

What the API returns

Each response code below includes the documented payload shape for the ACP API.

200Claim renewedapplication/json
FieldTypeRequiredDescription
dispatchobjectYes
dispatch.idstringYesUnique identifier.
dispatch.kindevaluation_run | test_run | agent_optimizationYes
dispatch.resourceIdstringYes
dispatch.parentResourceIdstringNo
dispatch.userIdstringNoUser ID.
dispatch.organizationIdstringNo
dispatch.statusqueued | leased | retry_wait | completed | cancelled | dead_letterYesCurrent lifecycle status.
dispatch.reasonstringYes
dispatch.priorityintegerYes
dispatch.attemptCountintegerYes
dispatch.maxAttemptsintegerYes
dispatch.availableAtstringYes
dispatch.claimOwnerstringNo
dispatch.claimExpiresAtstringNo
dispatch.heartbeatAtstringNo
dispatch.credentialIdstringNo
dispatch.lastErrorstringNo
dispatch.lastErrorClassificationtransient | permanentNo
dispatch.createdAtstringYesISO 8601 timestamp.
dispatch.updatedAtstringYesISO 8601 timestamp.
dispatch.completedAtstringNoISO 8601 timestamp.
dispatch.deadLetteredAtstringNo
dispatch.metadataobjectYesFree-form metadata object.
409Claim expired
None.
Renew an execution dispatch claim
Loading...
Response 200
Loading...
See the ACP quickstart and SDK flow