sdkDeterministic

Claim agent chat turn

pipeline.claimAgentChatTurn

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.

Parameters

workspaceId

string

No description.

actionrequired

string

No description.

turnIdrequired

string

No description.

Example

TypeScripttypescript

await pipeline.claimAgentChatTurn({
  "action": "external_claim",
  "turnId": "00000000-0000-4000-8000-000000000000"
})

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "turnId": {
      "type": "string"
    },
    "conversationId": {
      "type": "string"
    },
    "claimToken": {
      "type": "string"
    },
    "leaseExpiresAt": {
      "type": "string"
    },
    "executionMode": {
      "type": "string",
      "enum": [
        "external_agent"
      ]
    },
    "role": {
      "type": "string"
    },
    "roleDescription": {
      "type": "string"
    },
    "instructions": {
      "type": "string"
    },
    "surfaceContext": {
      "type": [
        "object",
        "null"
      ]
    },
    "input": {
      "type": "object"
    },
    "history": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "selectedSkill": {
      "type": [
        "object",
        "null"
      ]
    },
    "delegatedResults": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  },
  "required": [
    "turnId",
    "conversationId",
    "claimToken",
    "leaseExpiresAt",
    "executionMode",
    "role",
    "roleDescription",
    "instructions",
    "surfaceContext",
    "input",
    "history",
    "selectedSkill",
    "delegatedResults"
  ]
}

Exceptions

PipelineError: Thrown for validation, authentication, JSON-RPC, HTTP, and network failures. Inspect code and data when present.