Workflows
Create a Workflow
Authorization
API Key x-api-key<token>
Authenticate using API Key in request header
In: header
Request Body
application/json
name*string
Name of workflow. Can be updated to rename the workflow. Must be unique within the environment and match the pattern ^[a-zA-Z0-9_-]{1,128}$.
Match
^[a-zA-Z0-9_-]{1,128}$Length
1 <= length <= 128displayName?string
Display name of workflow.
tags?array<string>
Array of tags to categorize and organize workflows.
mainFunction*
Main function for the workflow. The mainFunction and relationships fields act as a unit and must be provided together, or neither provided.
- If
mainFunctionis provided withoutrelationships, relationships will default to an empty array. - If
relationshipsis provided,mainFunctionmust also be provided (validation error if missing). - If neither is provided, both mainFunction and relationships remain unchanged from the current workflow version.
relationships?
Relationships between functions in the workflow. The mainFunction and relationships fields act as a unit and must be provided together, or neither provided.
- If
relationshipsis provided,mainFunctionmust also be provided (validation error if missing). - If
mainFunctionis provided withoutrelationships, relationships will default to an empty array. - If neither is provided, both mainFunction and relationships remain unchanged from the current workflow version.
Response Body
application/json
curl -X POST "https://api.bem.ai/v2/workflows" \ -H "Content-Type: application/json" \ -d '{}'{
"workflow": {
"id": "string",
"name": "string",
"versionNum": 0,
"displayName": "string",
"emailAddress": "string",
"tags": [
"billing",
"finance",
"automated"
],
"mainFunction": {
"id": "string",
"name": "string",
"versionNum": 0
},
"relationships": [
{
"sourceFunction": {
"id": "string",
"name": "string",
"versionNum": 0
},
"destinationName": "string",
"destinationFunction": {
"id": "string",
"name": "string",
"versionNum": 0
}
}
],
"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"
}