Enrichment Tables / REST API
Apply table playbook
Apply one implemented playbook as a typed parent and child column family. Validates mappings and workspace BYOK but never executes rows.
POST /api/v1/tables/playbooks/applyDeterministic operationParameters
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.
curl -X POST "https://app.pipeline.help/api/v1/tables/playbooks/apply" \
-H "Authorization: Bearer $PIPELINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"tableId":"00000000-0000-4000-8000-000000000000","playbookId":"pricing-plans","inputMappings":{},"executionMode":"pipeline_hosted"}'Full 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"
]
}