List Pipelines
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
Retrieves configurations for all existing pipelines.
Authenticate using API Key in request header
In: header
Query Parameters
501 <= value <= 100A cursor to use in pagination. startingAfter is a pipeline ID that defines your place in the list. For example, if you make a list request and receive 50 objects, ending with pl_2c9AXIj48cUYJtCuv1gsQtHGDzK, your subsequent call can include startingAfter=pl_2c9AXIj48cUYJtCuv1gsQtHGDzK to fetch the next page of the list.
A cursor to use in pagination. endingBefore is a pipeline ID that defines your place in the list. For example, if you make a list request and receive 50 objects, starting with pl_2c9AXIj48cUYJtCuv1gsQtHGDzK, your subsequent call can include endingBefore=pl_2c9AXIj48cUYJtCuv1gsQtHGDzK to fetch the previous page of the list.
Response Body
curl -X GET "https://api.bem.ai/v1-beta/pipelines?limit=50&startingAfter=string&endingBefore=string"[
{
"pipelineID": "string",
"name": "Freight Load Pipeline",
"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."
}
}
}
}
}
},
"outputSchemaName": "Freight Load Schema",
"emailAddress": "eml_2c9AXFXHwiaL4vPXDTOS171OJ8T@pipeline.bem.ai",
"webhookEnabled": true,
"webhookURL": "https://bem-example.ai/test/url",
"independentDocumentProcessingEnabled": false,
"complexTabularTransformEnabled": true
}
]