Update a Function

Update a function. Updates create a new version.

The previous version remains addressable and immutable. Workflow nodes that pinned the function with a versionNum continue to use the pinned version; nodes that reference the function by name with no version automatically pick up the new version on their next call.

What you can change

Any field allowed by the function's type. Most commonly: outputSchema (for extract/join), classifications (for classify), displayName, and tags.

Versioning behaviour

Each successful update increments currentVersionNum by 1.
displayName, tags, and functionName updates also create a new version, so the version history is a complete record of every change.
To revert, fetch the previous version and re-submit its configuration as a new update — versions themselves are immutable.

Authorization

API Key

x-api-key<token>

Authenticate using API Key in request header

In: header

Path Parameters

functionName*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

functionName?string

Name of function. Must be UNIQUE on a per-environment basis.

displayName?string

Display name of function. Human-readable name to help you identify the function.

tags?array<>

Array of tags to categorize and organize functions.

type*string

Value in"extract"

outputSchemaName?string

Name of output schema object.

outputSchema?object

Desired output structure defined in standard JSON Schema convention.

tabularChunkingEnabled?boolean

Whether tabular chunking is enabled. When true, tables in CSV/Excel files are processed in row batches rather than all at once.

enableBoundingBoxes?boolean

Whether bounding box extraction is enabled. Applies to vision input types (pdf, png, jpeg, heic, heif, webp) that dispatch through the analyze path. When true, the function returns the document regions (page, coordinates) from which each field was extracted. Enabling this automatically configures the function to use the bounding box model. Disabling resets to the default.

preCount?boolean

Reducing the risk of the model stopping early on long documents. Trade-off: Increases total latency. Compatible with enableBoundingBoxes.

Response Body

`application/json`

curl -X PATCH "https://api.bem.ai/v3/functions/string" \  -H "Content-Type: application/json" \  -d '{    "type": "extract"  }'

{
  "function": {
    "functionID": "string",
    "functionName": "string",
    "versionNum": 0,
    "usedInWorkflows": [
      {
        "workflowID": "string",
        "workflowName": "string",
        "currentVersionNum": 0,
        "usedInWorkflowVersionNums": [
          0
        ]
      }
    ],
    "displayName": "string",
    "tags": [
      "string"
    ],
    "audit": {
      "functionCreatedBy": {
        "userActionID": "string",
        "userID": "string",
        "userEmail": "string",
        "apiKeyName": "string",
        "emailAddress": "string",
        "createdAt": "2019-08-24T14:15:22Z"
      },
      "functionLastUpdatedBy": {
        "userActionID": "string",
        "userID": "string",
        "userEmail": "string",
        "apiKeyName": "string",
        "emailAddress": "string",
        "createdAt": "2019-08-24T14:15:22Z"
      },
      "versionCreatedBy": {
        "userActionID": "string",
        "userID": "string",
        "userEmail": "string",
        "apiKeyName": "string",
        "emailAddress": "string",
        "createdAt": "2019-08-24T14:15:22Z"
      }
    },
    "type": "transform",
    "outputSchemaName": "string",
    "outputSchema": {},
    "emailAddress": "string",
    "tabularChunkingEnabled": true
  }
}