Building a webhook integration? Read the webhook guide for signatures, retries, event schemas, and troubleshooting.

apiDeterministic

Release agent work order

POST /api/agents/work-orders/external/release

Release an external coding agent work-order lease without submitting an artifact. Use this when the agent cannot complete the task so another worker can claim it. This does not launch or send anything.

Parameters

workspaceId

string

Optional with an API key, inferred from the key.

workOrderIdrequired

string

No description.

claimTokenrequired

string

Lease token returned by claim-agent-work-order.

Example

REST requestbash

curl -X POST "https://app.pipeline.help/api/agents/work-orders/external/release" \
  -H "Authorization: Bearer $PIPELINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workOrderId":"00000000-0000-4000-8000-000000000000","claimToken":"00000000-0000-4000-8000-000000000001"}'

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "released": {
      "type": "boolean"
    }
  },
  "required": [
    "released"
  ]
}

HTTP errors

401: Missing or invalid API key.
403: Authenticated but not permitted for the workspace or resource.
404: The requested resource was not found.