v1

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-05-044743166.6 KB

waitpoints

Complete a waitpoint token

Completes a waitpoint token, unblocking any run that is waiting for it via wait.forToken(). An optional data payload can be passed and will be returned to the waiting run. If the token is already completed, this is a no-op and returns success: true.

This endpoint accepts both secret API keys and short-lived JWTs (public access tokens), making it safe to call from frontend clients.

post/api/v1/waitpoints/tokens/{waitpointId}/complete

Path parameters

waitpointIdstring required

The ID of the waitpoint token to complete.

Request body

{"stackTrail":"components:schemas:CompleteWaitpointTokenRequest:properties:data","oasType":"schema","type":"unknown","description":"Any JSON-serializable value to pass back to the run waiting on this token. The data will be returned from `wait.forToken()` as the result payload.","example":{"status":"approved","comment":"Looks good to me!"}}

Example request

{
  "data": {
    "status": "approved",
    "comment": "Looks good to me!"
  }
}

Response

Waitpoint token completed successfully

successtrue required

Always true when the request succeeds.