List Functions

GET 
https://api.bem.ai/v2/functions

List Functions

Request

Query Parameters

limit integer
Possible values: >= 1 and <= 100
Default value: 50
functionIDs string[]

Possible values: >= 1

functionNames string[]

Possible values: >= 1

types FunctionType[]

Possible values: [transform, route, split, join], >= 1

sortOrder string
Possible values: [asc, desc]
Specifies sorting behavior. The two options are asc and desc to sort ascending and descending respectively, with default sort being ascending. Paging works in both directions.
Default value: asc
startingAfter string

A cursor to use in pagination. startingAfter is a function ID that defines your place in the list.

endingBefore string

A cursor to use in pagination. endingBefore is a function ID that defines your place in the list.

tags string[]
Possible values: >= 1
Filter functions by tags. Functions must contain all specified tags.
Example: [billing, finance]

Responses

200

A list of functions

application/json

Schema

Schema

functions object[]
Array [
oneOf
TransformFunction
functionIDstringrequired
Unique identifier of function.
functionNamestringrequired
Name of function. Must be UNIQUE on a per-environment basis.
typeFunctionType (string)required
The type of the function.
Possible values: [transform, route, split, join]
displayNamestring
Display name of function. Human-readable name to help you identify the function.
tagsstring[]
Array of tags to categorize and organize functions.
Example: ["billing","finance","automated"]
outputSchemaNamestringrequired
Name of output schema object.
Example: Freight Load Schema
outputSchemaobjectrequired
Desired output structure defined in standard JSON Schema convention.
Example: {"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."}}}}}}
emailAddressstringrequired
Email address automatically created by bem. You can forward emails with or without attachments, to be transformed.
Example: eml_2c9AXFXHwiaL4vPXDTOS171OJ8T@pipeline.bem.ai
independentDocumentProcessingEnabledbooleanrequired
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.
Example: false
complexTabularTransformEnabledbooleanrequired
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.
RouteFunction
functionIDstringrequired
Unique identifier of function.
functionNamestringrequired
Name of function. Must be UNIQUE on a per-environment basis.
typeFunctionType (string)required
The type of the function.
Possible values: [transform, route, split, join]
displayNamestring
Display name of function. Human-readable name to help you identify the function.
tagsstring[]
Array of tags to categorize and organize functions.
Example: ["billing","finance","automated"]
descriptionstringrequired
Description of router. Can be used to provide additional context on router's purpose and expected inputs.
routes object[]required
List of routes.
Array [
namestringrequired
Name of route. Should indicate what the input type or intent is to appropriately analyze input.
descriptionstring
Description of route. Can be used to provide additional context on route's purpose.
origin object
The origin of the route.
email object
patternsstring[]
Regular expression to match against the email address, using the Go (RE2) regex syntax.
regex object
Regex to match against the input.
patternsstring[]
Regular expression to match against the input, using the Go (RE2) regex syntax.
functionIDstring
ID of function to run after routing.
functionNamestring
Name of function to run after routing.
actionTypeConfigIDstringdeprecated
DEPRECATED - use functionID instead. ID of action type config to run after routing.
]
emailAddressstringrequired
Email address automatically created by bem. You can forward emails with or without attachments, to be routed.
Example: eml_2c9AXFXHwiaL4vPXDTOS171OJ8T@actions.bem.ai
SplitFunction
functionIDstringrequired
Unique identifier of function.
functionNamestringrequired
Name of function. Must be UNIQUE on a per-environment basis.
typeFunctionType (string)required
The type of the function.
Possible values: [transform, route, split, join]
displayNamestring
Display name of function. Human-readable name to help you identify the function.
tagsstring[]
Array of tags to categorize and organize functions.
Example: ["billing","finance","automated"]
splitTypestringrequired
Possible values: [print_page, semantic_page]
printPageSplitConfig object
nextFunctionIDstring
The unique ID of the function you want to use after splitting.
semanticPageSplitConfig object
itemClasses object[]
Array [
namestringrequired
descriptionstring
nextFunctionIDstring
The unique ID of the function you want to use for this item class.
nextFunctionNamestring
The unique name of the function you want to use for this item class.
]
JoinFunction
functionIDstringrequired
Unique identifier of function.
functionNamestringrequired
Name of function. Must be UNIQUE on a per-environment basis.
typeFunctionType (string)required
The type of the function.
Possible values: [transform, route, split, join]
displayNamestring
Display name of function. Human-readable name to help you identify the function.
tagsstring[]
Array of tags to categorize and organize functions.
Example: ["billing","finance","automated"]
descriptionstringrequired
Description of join function.
joinTypestringrequired
The type of join to perform.
Possible values: [standard]
outputSchemaNamestringrequired
Name of output schema object.
Example: Freight Load Schema
outputSchemaobjectrequired
Desired output structure defined in standard JSON Schema convention.
Example: {"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."}}}}}}
]
totalCountinteger

The total number of results available.

Example (auto)

{
  "functions": [
    {
      "functionID": "string",
      "functionName": "string",
      "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
    },
    {
      "functionID": "string",
      "functionName": "string",
      "type": "transform",
      "displayName": "string",
      "tags": [
        "billing",
        "finance",
        "automated"
      ],
      "description": "string",
      "routes": [
        {
          "name": "string",
          "description": "string",
          "origin": {
            "email": {
              "patterns": [
                "string"
              ]
            }
          },
          "regex": {
            "patterns": [
              "string"
            ]
          },
          "functionID": "string",
          "functionName": "string"
        }
      ],
      "emailAddress": "eml_2c9AXFXHwiaL4vPXDTOS171OJ8T@actions.bem.ai"
    },
    {
      "functionID": "string",
      "functionName": "string",
      "type": "transform",
      "displayName": "string",
      "tags": [
        "billing",
        "finance",
        "automated"
      ],
      "splitType": "print_page",
      "printPageSplitConfig": {
        "nextFunctionID": "string"
      },
      "semanticPageSplitConfig": {
        "itemClasses": [
          {
            "name": "string",
            "description": "string",
            "nextFunctionID": "string",
            "nextFunctionName": "string"
          }
        ]
      }
    },
    {
      "functionID": "string",
      "functionName": "string",
      "type": "transform",
      "displayName": "string",
      "tags": [
        "billing",
        "finance",
        "automated"
      ],
      "description": "string",
      "joinType": "standard",
      "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."
                }
              }
            }
          }
        }
      }
    }
  ],
  "totalCount": 0
}

Authorization: x-api-key

name: x-api-keytype: apiKeyin: header

• curl
• python
• go
• nodejs
• java

• CURL

curl -L 'https://api.bem.ai/v2/functions' \
-H 'Accept: application/json' \
-H 'x-api-key: <x-api-key>'

Request Collapse all

Base URL

https://api.bem.ai

Auth

ApiKeyAuth

Parameters

limit — query

functionIDs — query

functionNames — query

types — query

transformroutesplitjoin

sortOrder — query

---ascdesc

startingAfter — query

endingBefore — query

tags — query

ResponseClear

Click the Send API Request button above and see the response here!