const options = {
method: "POST",
headers: {
"x-api-key": "<your-api-key>",
"Content-Type": "application/json",
},
body: JSON.stringify({
leadId: "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
agentId: "7c9e6679-7425-40de-944b-e07fc1f90ae7",
workflowId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
}),
};
fetch("https://api-v2.getomni.ai/api/v1/workflow-runs", options)
.then((response) => response.json())
.then((response) => console.log(response))
.catch((err) => console.error(err));
import requests
url = "https://api-v2.getomni.ai/api/v1/workflow-runs"
headers = {"x-api-key": "<your-api-key>", "Content-Type": "application/json"}
payload = {
"leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
"agentId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.json())
curl --request POST \
--url https://api-v2.getomni.ai/api/v1/workflow-runs \
--header 'x-api-key: <your-api-key>' \
--header 'Content-Type: application/json' \
--data '{
"leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
"agentId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'
{
"success": true,
"workflowRun": {
"id": "5d8c1b2a-3e4f-5061-7283-94a5b6c7d8e9",
"leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
"agentId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "ACTIVE",
"createdAt": "2026-09-10T17:42:03.000Z",
"completedAt": null,
"cancelledAt": null
}
}
Workflow Runs
Create Workflow Run
Start an agent conducting a workflow on a lead
POST
/
api
/
v1
/
workflow-runs
const options = {
method: "POST",
headers: {
"x-api-key": "<your-api-key>",
"Content-Type": "application/json",
},
body: JSON.stringify({
leadId: "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
agentId: "7c9e6679-7425-40de-944b-e07fc1f90ae7",
workflowId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
}),
};
fetch("https://api-v2.getomni.ai/api/v1/workflow-runs", options)
.then((response) => response.json())
.then((response) => console.log(response))
.catch((err) => console.error(err));
import requests
url = "https://api-v2.getomni.ai/api/v1/workflow-runs"
headers = {"x-api-key": "<your-api-key>", "Content-Type": "application/json"}
payload = {
"leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
"agentId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.json())
curl --request POST \
--url https://api-v2.getomni.ai/api/v1/workflow-runs \
--header 'x-api-key: <your-api-key>' \
--header 'Content-Type: application/json' \
--data '{
"leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
"agentId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'
{
"success": true,
"workflowRun": {
"id": "5d8c1b2a-3e4f-5061-7283-94a5b6c7d8e9",
"leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
"agentId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "ACTIVE",
"createdAt": "2026-09-10T17:42:03.000Z",
"completedAt": null,
"cancelledAt": null
}
}
Create a workflow run: one agent conducting one workflow on one lead. Get the
No other fields are accepted.
agentId from List Agents and the workflowId from List Workflows.
Depending on the workflow’s type, the agent may begin sending messages to the lead.
Authentication
Requires thex-api-key header with a valid workspace API key.
Body Parameters
string
required
The lead the workflow is conducted on.
string
required
The agent that conducts the workflow.
string
required
The workflow the agent conducts.
Response
boolean
Whether the request succeeded.
object
The new workflow run. See Get Workflow Run
for the full shape. A new workflow run is always
ACTIVE.Errors
error
leadId, agentId, or workflowId is missing, or the body carries an
unrecognized field.error
The
leadId, agentId, or workflowId isn’t in your workspace.error
The workflow run cannot be created:
Agent is already linked to this lead: this agent already has an open (ACTIVEorPAUSED) workflow run on this lead. Cancel or complete it first, or use a different agent.… already collects this lead's checklist: a lead can have only one openCHECKLISTworkflow run at a time.This reminder workflow has no schedule configured yet: theREMINDERworkflow needs a schedule set in the Monumint app first.
const options = {
method: "POST",
headers: {
"x-api-key": "<your-api-key>",
"Content-Type": "application/json",
},
body: JSON.stringify({
leadId: "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
agentId: "7c9e6679-7425-40de-944b-e07fc1f90ae7",
workflowId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
}),
};
fetch("https://api-v2.getomni.ai/api/v1/workflow-runs", options)
.then((response) => response.json())
.then((response) => console.log(response))
.catch((err) => console.error(err));
import requests
url = "https://api-v2.getomni.ai/api/v1/workflow-runs"
headers = {"x-api-key": "<your-api-key>", "Content-Type": "application/json"}
payload = {
"leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
"agentId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.json())
curl --request POST \
--url https://api-v2.getomni.ai/api/v1/workflow-runs \
--header 'x-api-key: <your-api-key>' \
--header 'Content-Type: application/json' \
--data '{
"leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
"agentId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'
{
"success": true,
"workflowRun": {
"id": "5d8c1b2a-3e4f-5061-7283-94a5b6c7d8e9",
"leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
"agentId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "ACTIVE",
"createdAt": "2026-09-10T17:42:03.000Z",
"completedAt": null,
"cancelledAt": null
}
}