Enrichment Tables / TypeScript SDK

Apply table playbook

Name: Pipeline
Price: 99 USD

Apply one implemented playbook as a typed parent and child column family. Validates mappings and workspace BYOK but never executes rows.

pipeline.applyTablePlaybookDeterministic operation

Parameters

workspaceIdOptional · string: Optional with API key auth, inferred from the key.
tableIdRequired · string: See the input schema for this field.
playbookIdRequired · string: Playbook ID returned by list-table-playbookspricing-plans · new-in-role
inputMappingsRequired · object: Playbook input key to existing Table column ID.
executionModeRequired · string: See the input schema for this field.pipeline_hosted · external_agent
llmCredentialIdOptional · string: See the input schema for this field.
searchCredentialIdOptional · string: See the input schema for this field.
providerCredentialIdOptional · string: See the input schema for this field.
allowDuplicateOptional · boolean: See the input schema for this field.
allowHostedAiOptional · boolean: Required for API, MCP, CLI, and SDK callers that explicitly choose pipeline_hosted execution.

Request example

await pipeline.applyTablePlaybook({
  "tableId": "00000000-0000-4000-8000-000000000000",
  "playbookId": "pricing-plans",
  "inputMappings": {},
  "executionMode": "pipeline_hosted"
})

Full input schema

Input schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "workspaceId": {
      "type": "string",
      "description": "Optional with API key auth, inferred from the key."
    },
    "tableId": {
      "type": "string"
    },
    "playbookId": {
      "type": "string",
      "enum": [
        "pricing-plans",
        "new-in-role"
      ],
      "description": "Playbook ID returned by list-table-playbooks"
    },
    "inputMappings": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Playbook input key to existing Table column ID."
    },
    "executionMode": {
      "type": "string",
      "enum": [
        "pipeline_hosted",
        "external_agent"
      ]
    },
    "llmCredentialId": {
      "type": "string"
    },
    "searchCredentialId": {
      "type": "string"
    },
    "providerCredentialId": {
      "type": "string"
    },
    "allowDuplicate": {
      "type": "boolean"
    },
    "allowHostedAi": {
      "type": "boolean",
      "description": "Required for API, MCP, CLI, and SDK callers that explicitly choose pipeline_hosted execution."
    }
  },
  "required": [
    "tableId",
    "playbookId",
    "inputMappings",
    "executionMode"
  ]
}

See this operation inCLI MCP REST API