Calls

Get a Call

Retrieve detailed information about a specific call.

Returns the full call object including:

  • Current status (pending, running, completed, failed)
  • Timing information (createdAt, finishedAt)
  • Associated workflow or function details
  • Nested function calls (for workflow executions)
  • Input data and transformation results

Call Status

StatusDescription
pendingCall is queued and waiting to be processed
runningCall is currently being executed
completedCall finished successfully
failedCall encountered an error during execution

Polling for Results

For asynchronous calls, poll this endpoint to check when processing completes. The finishedAt timestamp will be populated once the call reaches a terminal state.

GET
/v2/calls/{callID}
x-api-key<token>

Authenticate using API Key in request header

In: header

Path Parameters

callID*string

The unique identifier of the call to retrieve

Response Body

application/json

curl -X GET "https://api.bem.ai/v2/calls/string"
{
  "call": {
    "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"
          }
        ]
      }
    }
  },
  "error": "string"
}