Update a Pipeline

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Updates an existing pipeline. Follow conventional PATCH behavior, so only included fields will be updated.

Authorization

API Key

x-api-key<token>

Authenticate using API Key in request header

In: header

Path Parameters

pipelineID*string

ID of the pipeline to update

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Name of pipeline

outputSchemaName?string

Name of output schema object.

outputSchema?object

Desired output structure defined in standard JSON Schema convention. Note - We DO NOT support non-alphanumeric characters in names of fields.

webhookEnabled?booleanDeprecated

DEPRECATED - use subscriptions for webhook events. Whether webhook functionality is enabled.

webhookURL?stringDeprecated

DEPRECATED - use subscriptions for webhook events. URL bem will send webhook requests to with successful transformation outputs if webhooks are enabled for the pipeline.

tabularChunkingEnabled?boolean

Whether tabular chunking is enabled on the pipeline. This processes tables in CSV/Excel in row batches, rather than all rows at once.

independentDocumentProcessingEnabled?boolean

Whether independent transformations is enabled. For PDFs sent through the pipeline, this enables independent transformations for each individual page. For CSVs, this enables transforming chunks of rows in the CSV.

Response Body

`application/json`

curl -X PATCH "https://api.bem.ai/v1-beta/pipelines/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "pipelineID": "string",
  "name": "string",
  "outputSchema": {},
  "outputSchemaName": "string",
  "emailAddress": "string",
  "webhookEnabled": true,
  "webhookURL": "string",
  "tabularChunkingEnabled": true,
  "independentDocumentProcessingEnabled": true
}