Calls
List Calls
Retrieve a list of workflow and function calls with filtering options.
Use this endpoint to:
- Monitor the status of submitted calls
- Search for calls by reference ID, workflow, or function
- Paginate through large result sets
Filtering Options
Filter calls using any combination of:
callIDs: Specific call identifiersreferenceIDs: Your custom reference IDs (set viacallReferenceID)callTypes: Filter by call typeworkflowIDs/workflowNames: Filter by workflowfunctionIDs/functionNames: Filter by function
Pagination
Results are paginated with a default limit of 50. Use startingAfter and endingBefore
cursors for efficient pagination through large result sets.
Authorization
API Key x-api-key<token>
Authenticate using API Key in request header
In: header
Query Parameters
limit?integer
Default
50Range
1 <= value <= 100callIDs?array<>
Items
1 <= itemscallTypes?array<>
Items
1 <= itemsworkflowIDs?array<>
Items
1 <= itemsworkflowNames?array<>
Items
1 <= itemsfunctionIDs?array<>
Items
1 <= itemsfunctionNames?array<>
Items
1 <= itemsreferenceIDs?array<>
Items
1 <= itemsreferenceIDSubstring?string
Used for search over referenceIDs of calls. Will perform case-insensitive substring matching.
sortOrder?string
Default
"asc"Value in
"asc" | "desc"startingAfter?string
endingBefore?string
Response Body
application/json
curl -X GET "https://api.bem.ai/v2/calls"{
"calls": [
{
"callID": "string",
"callType": "string",
"status": "pending",
"createdAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"workflowID": "string",
"workflowName": "string",
"workflowVersionNum": 0,
"functionID": "string",
"functionName": "string",
"functionType": "string",
"functionVersionNum": 0,
"callReferenceID": "string",
"functionCalls": [
{
"functionCallID": "string",
"functionID": "string",
"functionName": "string",
"type": "transform",
"referenceID": "string",
"status": "pending",
"functionVersionNum": 0,
"activity": [
{
"displayName": "string",
"status": "pending"
}
],
"sourceFunctionCallID": "string",
"workflowCallID": "string",
"inputType": "string",
"s3URL": "string",
"inputs": [
{
"inputType": "string",
"itemReferenceID": "string",
"s3URL": "string"
}
]
}
],
"input": {
"singleFile": {
"inputType": "string",
"s3URL": "string"
},
"batchFiles": {
"inputs": [
{
"inputType": "string",
"itemReferenceID": "string",
"s3URL": "string"
}
]
}
}
}
],
"totalCount": 0,
"error": "string"
}