Agents / TypeScript SDK

Claim agent work order

Lease one claimable Agent Teams work order for execution inside an external coding agent. Returns a versioned execution bundle containing the same Pipeline-owned first-party skill loadout, authority order, task context, allowed tools, and output schema used by hosted Agent Teams. The external agent uses its own subscription for inference. Claiming marks the work order running and never authorizes launch or sending.

pipeline.claimAgentWorkOrderDeterministic operation

Parameters

workspaceIdOptional · string: Optional with an API key, inferred from the key.
workOrderIdRequired · string: The claimable work order id from list-agent-work-orders.
clientNameRequired · string: Coding agent client name, for example codex, claude-code, or hermes.
clientRunIdRequired · string: Caller-stable run identifier used for traceability.
leaseSecondsOptional · number: Optional lease duration from 60 to 3600 seconds.
nativeCapabilitiesOptional · array: Optional native research capabilities available in the claiming client.
freshnessWindowHoursOptional · integer: Optional maximum evidence age in hours. Zero requires current evidence.
requiresScaleOptional · boolean: Whether the claimed work is expected to continue from pilot into scale.

Request example

await pipeline.claimAgentWorkOrder({
  "workOrderId": "00000000-0000-4000-8000-000000000000",
  "clientName": "example",
  "clientRunId": "00000000-0000-4000-8000-000000000000"
})

Full input schema

Input schema

{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string",
      "description": "Optional with an API key, inferred from the key."
    },
    "workOrderId": {
      "type": "string",
      "description": "The claimable work order id from list-agent-work-orders."
    },
    "clientName": {
      "type": "string",
      "description": "Coding agent client name, for example codex, claude-code, or hermes."
    },
    "clientRunId": {
      "type": "string",
      "description": "Caller-stable run identifier used for traceability."
    },
    "leaseSeconds": {
      "type": "number",
      "description": "Optional lease duration from 60 to 3600 seconds."
    },
    "nativeCapabilities": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "web_search",
          "web_fetch"
        ]
      },
      "maxItems": 2,
      "uniqueItems": true,
      "description": "Optional native research capabilities available in the claiming client."
    },
    "freshnessWindowHours": {
      "type": "integer",
      "minimum": 0,
      "description": "Optional maximum evidence age in hours. Zero requires current evidence."
    },
    "requiresScale": {
      "type": "boolean",
      "description": "Whether the claimed work is expected to continue from pilot into scale."
    }
  },
  "required": [
    "workOrderId",
    "clientName",
    "clientRunId"
  ]
}

See this operation inCLI MCP REST API