Update a Function
Authenticate using API Key in request header
In: header
Path Parameters
Name of function. Must be UNIQUE on a per-environment basis.
Display name of function. Human-readable name to help you identify the function.
Array of tags to categorize and organize functions.
Name of output schema object.
Desired output structure defined in standard JSON Schema convention.
Empty Object
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.
Whether complex tabular transforms are enabled on the pipeline. This enables the pipeline to parse CSVs with multiple tables in the same file, and to transpose CSVs that can't be parsed row-wise.
Name of function. Must be UNIQUE on a per-environment basis.
Display name of function. Human-readable name to help you identify the function.
Array of tags to categorize and organize functions.
Name of output schema object.
Desired output structure defined in standard JSON Schema convention.
Empty Object
Name of function. Must be UNIQUE on a per-environment basis.
Display name of function. Human-readable name to help you identify the function.
Array of tags to categorize and organize functions.
Description of router. Can be used to provide additional context on router's purpose and expected inputs.
List of routes.
Name of function. Must be UNIQUE on a per-environment basis.
Display name of function. Human-readable name to help you identify the function.
Array of tags to categorize and organize functions.
"print_page" | "semantic_page"Name of function. Must be UNIQUE on a per-environment basis.
Display name of function. Human-readable name to help you identify the function.
Array of tags to categorize and organize functions.
Description of join function.
The type of join to perform.
"standard"Name of output schema object.
Desired output structure defined in standard JSON Schema convention.
Empty Object
Response Body
curl -X PUT "https://api.bem.ai/v2/functions/string" \
-H "Content-Type: application/json" \
-d '{}'{
"functionID": "string",
"functionName": "string",
"versionNum": 0,
"type": "transform",
"displayName": "string",
"tags": [
"billing",
"finance",
"automated"
],
"outputSchemaName": "Freight Load Schema",
"outputSchema": {
"type": "object",
"required": [
"tenders"
],
"properties": {
"tenders": {
"type": "array",
"items": {
"type": "object",
"required": [
"loadReference",
"origin",
"destination",
"weightTons",
"loadType",
"desiredDeliveryDate",
"bidSubmissionDeadline",
"submitter"
],
"properties": {
"origin": {
"type": "string",
"description": "The starting point of the shipment."
},
"loadType": {
"type": "string",
"description": "The type of goods being shipped."
},
"submitter": {
"type": "object",
"required": [
"name",
"position",
"contactInfo"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the person submitting the tender."
},
"position": {
"type": "string",
"description": "Position of the submitter within their company."
},
"contactInfo": {
"type": "object",
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"description": "Email address of the submitter."
},
"phone": {
"type": "string",
"description": "Phone number of the submitter."
}
}
}
}
},
"weightTons": {
"type": "number",
"description": "The weight of the load in tons."
},
"destination": {
"type": "string",
"description": "The endpoint of the shipment."
},
"loadReference": {
"type": "string",
"description": "Unique identifier for the load tender."
},
"desiredDeliveryDate": {
"type": "string",
"format": "date",
"description": "The preferred date for the shipment to be delivered."
},
"bidSubmissionDeadline": {
"type": "string",
"format": "date",
"description": "The deadline for submitting bids."
}
}
}
}
}
},
"emailAddress": "eml_2c9AXFXHwiaL4vPXDTOS171OJ8T@pipeline.bem.ai",
"independentDocumentProcessingEnabled": false,
"complexTabularTransformEnabled": true
}