Agents / REST API

Claim agent chat turn

Claim an external Agent Teams chat turn for ten minutes. Returns the addressed role, user input, saved history, selected skill, constraints and claimToken. Use your current coding-agent model, not Pipeline hosted inference. The UI shows this turn as running. Claims are principal/workspace scoped and cannot claim hosted turns.

POST /api/agents/conversationsDeterministic operation

Parameters

workspaceIdOptional · string: See the input schema for this field.
actionRequired · string: See the input schema for this field.
turnIdRequired · string: See the input schema for this field.

Request example

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

Full input schema

Input schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string",
      "format": "uuid"
    },
    "action": {
      "default": "external_claim",
      "type": "string",
      "const": "external_claim"
    },
    "turnId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "required": [
    "action",
    "turnId"
  ],
  "additionalProperties": false
}

See this operation inCLI MCP TypeScript SDK