sdkProvider-backed

Run enrichment

pipeline.runEnrichment

Run Pipeline-owned enrichment on a table using workspace BYOK credentials. This is never the default for Codex, Claude Code, or CLI external-agent execution. External agents should perform inference locally, persist flat outputs with update-table-rows, and mark the parent cell completed. Executes every enrichment column (or one columnId) against the selected rows.

Parameters

workspaceId

string

Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.

tableIdrequired

string

No description.

columnId

string

Optional. Run only this enrichment column. Omit to run every enrichment column on the table.

rowIds

string[]

Optional. Row IDs to enrich. Omit to run against all rows.

dryRun

boolean

Optional. Validate configuration and estimate cost without writing results or spending credits.

Example

TypeScripttypescript

await pipeline.runEnrichment({
  "tableId": "00000000-0000-4000-8000-000000000000"
})

Response

The operation is available, but its typed response schema has not been published yet.

Exceptions

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