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

apiDeterministic

Complete agent chat turn

POST /api/agents/conversations

Save your coding-agent-authored response as the addressed agent in its private chat, complete the leased external turn, and return any parent continuation. Report your actual provider and model as client-reported provenance. Persist real artifacts through Pipeline tools before claiming completion. Identical submission retries do not duplicate replies. No hosted inference.

Parameters

workspaceId

string

No description.

actionrequired

string

No description.

turnIdrequired

string

No description.

claimTokenrequired

string

No description.

textrequired

string

No description.

modelrequired

string

No description.

providerrequired

string

No description.

Example

REST requestbash

curl -X POST "https://app.pipeline.help/api/agents/conversations" \
  -H "Authorization: Bearer $PIPELINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"action":"external_complete","turnId":"00000000-0000-4000-8000-000000000000","claimToken":"00000000-0000-4000-8000-000000000000","text":"example","model":"example","provider":"example"}'

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "completed": {
      "type": "boolean"
    },
    "turnId": {
      "type": "string"
    },
    "continuation": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "turnId": {
          "type": "string"
        },
        "occurrence": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "completed",
    "turnId",
    "continuation"
  ]
}

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.