Functions
List Functions
x-api-key<token>
Authenticate using API Key in request header
In: header
Query Parameters
limit?integer
Default
50Range
1 <= value <= 100functionIDs?array<string>
functionNames?array<string>
displayName?string
Used for search over display names of functions. Will perform case-insensitive substring matching.
types?array<FunctionType>
sortOrder?string
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
"asc"Value in
"asc" | "desc"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?array<string>
Filter functions by tags. Functions must contain all specified tags.
Response Body
curl -X GET "https://api.bem.ai/v2/functions?limit=50&functionIDs=string&functionNames=string&displayName=string&types=transform&sortOrder=asc&startingAfter=string&endingBefore=string&tags=billing%2Cfinance"{
"functions": [
{
"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
}
],
"totalCount": 0
}