Skip to main content
POST
/
v1
/
user-workflow-runs
Create a workflow run
curl --request POST \
  --url https://api.tamtam.ai/api/v1/user-workflow-runs \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "FirstStepInput": "<unknown>",
  "Steps": [
    {
      "StepID": "<string>",
      "StepType": "<string>",
      "ParentStepID": "<string>"
    }
  ],
  "UserEmail": "<string>",
  "WorkflowRunID": "<string>"
}
'
{
  "Run": {
    "AccountID": "<string>",
    "CreatedAt": "2023-11-07T05:31:56Z",
    "ID": "<string>",
    "UpdatedAt": "2023-11-07T05:31:56Z",
    "UserEmail": "<string>"
  },
  "Status": "<string>",
  "Steps": [
    {
      "CreatedAt": "2023-11-07T05:31:56Z",
      "ID": "<string>",
      "Status": "<string>",
      "StepType": "<string>",
      "UpdatedAt": "2023-11-07T05:31:56Z",
      "UserWorkflowRunID": "<string>",
      "Input": "<unknown>",
      "Output": "<unknown>",
      "ParentStepID": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Account API key passed in the Authorization header

Body

application/json
FirstStepInput
any
required

Input data for the first step

Steps
object[] | null
required

List of steps to execute in the workflow

UserEmail
string
required

Email of the user who owns this workflow run

Example:

"elliot.alderson@tamtam.ai"

WorkflowRunID
string
required

Client-generated UUID for the workflow run

Example:

"b3c6f5e2-1234-4abc-9def-0123456789ab"

Response

Created

Run
object
required

Workflow run details

Status
string
required

Current status of the workflow run

Example:

"RUNNING"

Steps
object[] | null
required

List of steps in the workflow