Get a Workflow
Hand off to an LLM
Retrieve a workflow's current version by name.
Returns the full workflow record: currentVersionNum, mainNodeName,
the nodes array (with each node's function reference and pinned
versionNum if any), and the edges array. To inspect a historical
version, use GET /v3/workflows/{workflowName}/versions/{versionNum}.
Authorization
API Key x-api-key<token>
Authenticate using API Key in request header
In: header
Path Parameters
workflowName*string
Response Body
application/json
curl -X GET "https://api.bem.ai/v3/workflows/string"{
"workflow": {
"id": "string",
"name": "string",
"versionNum": 0,
"displayName": "string",
"emailAddress": "string",
"tags": [
"string"
],
"mainNodeName": "string",
"nodes": [
{
"name": "string",
"function": {
"id": "string",
"name": "string",
"versionNum": 0
},
"metadata": {}
}
],
"edges": [
{
"sourceNodeName": "string",
"destinationName": "string",
"destinationNodeName": "string",
"metadata": {}
}
],
"connectors": [
{
"connectorID": "string",
"name": "string",
"type": "paragon",
"paragon": {
"integration": "string",
"configuration": {},
"syncID": "string"
}
}
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"audit": {
"workflowCreatedBy": {
"userActionID": "string",
"userID": "string",
"userEmail": "string",
"apiKeyName": "string",
"emailAddress": "string",
"createdAt": "2019-08-24T14:15:22Z"
},
"workflowLastUpdatedBy": {
"userActionID": "string",
"userID": "string",
"userEmail": "string",
"apiKeyName": "string",
"emailAddress": "string",
"createdAt": "2019-08-24T14:15:22Z"
},
"versionCreatedBy": {
"userActionID": "string",
"userID": "string",
"userEmail": "string",
"apiKeyName": "string",
"emailAddress": "string",
"createdAt": "2019-08-24T14:15:22Z"
}
}
},
"error": "string"
}See also
- Workflows explained — concepts and patterns
- Quickstart — end-to-end example