Skip to main content
GET
/
api
/
workers
/
{workerId}
/
deployments
/
{deploymentId}
/
history
JavaScript
import BrainbaseLabs from 'brainbase-labs';

const client = new BrainbaseLabs({
  apiKey: process.env['BRAINBASE_LABS_API_KEY'], // This is the default and can be omitted
});

const history = await client.workers.deployments.history.retrieve('deploymentId', {
  workerId: 'workerId',
});

console.log(history.data);
{
  "data": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "deploymentId": "<string>",
      "changeType": "FLOW_VERSION",
      "committedFlowVersionId": "<string>",
      "previousValue": {},
      "newValue": {},
      "comment": "<string>",
      "changedById": "<string>",
      "deployedAt": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "flowVersion": 123,
      "metadata": {}
    }
  ],
  "total": 123,
  "hasMore": true
}

Authorizations

x-api-key
string
header
required

API key authentication

Path Parameters

workerId
string
required
deploymentId
string
required

Query Parameters

limit
integer
default:20
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0
changeType
enum<string>
Available options:
FLOW_VERSION,
CONFIG,
VOICE_SETTINGS,
STATUS,
PARAMETERS

Response

Paginated list of history entries

data
object[]
total
integer
hasMore
boolean