List of workflow events.













Events Endpoints
Events API.












Examples
Real world code examples
Get Stream Events
GET /v1/workflows/events/stream
Get Stream Events
200
Playground
Test the endpoints live
import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: "MISTRAL_API_KEY",
});
async function run() {
const result = await mistral.workflows.events.getStreamEvents({});
for await (const event of result) {
console.log(event);
}
}
run();
import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: "MISTRAL_API_KEY",
});
async function run() {
const result = await mistral.workflows.events.getStreamEvents({});
for await (const event of result) {
console.log(event);
}
}
run();
from mistralai.client import Mistral
import os
with Mistral(
api_key=os.getenv("MISTRAL_API_KEY", ""),
) as mistral:
res = mistral.workflows.events.get_stream_events(scope="*", activity_name="*", activity_id="*", workflow_name="*", workflow_exec_id="*", root_workflow_exec_id="*", parent_workflow_exec_id="*", stream="*", start_seq=0)
with res as event_stream:
for event in event_stream:
# handle event
print(event, flush=True)
from mistralai.client import Mistral
import os
with Mistral(
api_key=os.getenv("MISTRAL_API_KEY", ""),
) as mistral:
res = mistral.workflows.events.get_stream_events(scope="*", activity_name="*", activity_id="*", workflow_name="*", workflow_exec_id="*", root_workflow_exec_id="*", parent_workflow_exec_id="*", stream="*", start_seq=0)
with res as event_stream:
for event in event_stream:
# handle event
print(event, flush=True)
curl https://api.mistral.ai/v1/workflows/events/stream \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'curl https://api.mistral.ai/v1/workflows/events/stream \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'200
nullnullGet Workflow Events
GET /v1/workflows/events/list
Get Workflow Events
200
Successful Response
events
next_cursor
Cursor for pagination.
Playground
Test the endpoints live
import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: "MISTRAL_API_KEY",
});
async function run() {
const result = await mistral.workflows.events.getWorkflowEvents({});
console.log(result);
}
run();
import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: "MISTRAL_API_KEY",
});
async function run() {
const result = await mistral.workflows.events.getWorkflowEvents({});
console.log(result);
}
run();
from mistralai.client import Mistral
import os
with Mistral(
api_key=os.getenv("MISTRAL_API_KEY", ""),
) as mistral:
res = mistral.workflows.events.get_workflow_events(limit=100)
# Handle response
print(res)
from mistralai.client import Mistral
import os
with Mistral(
api_key=os.getenv("MISTRAL_API_KEY", ""),
) as mistral:
res = mistral.workflows.events.get_workflow_events(limit=100)
# Handle response
print(res)
curl https://api.mistral.ai/v1/workflows/events/list \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'curl https://api.mistral.ai/v1/workflows/events/list \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'200
{
"events": [
{
"attributes": {
"input": {
"value": "approved"
},
"task_id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"workflow_name": "support-workflow"
},
"event_id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"event_timestamp": 87,
"parent_workflow_exec_id": null,
"root_workflow_exec_id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"workflow_exec_id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"workflow_name": "support-workflow",
"workflow_run_id": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}
]
}{
"events": [
{
"attributes": {
"input": {
"value": "approved"
},
"task_id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"workflow_name": "support-workflow"
},
"event_id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"event_timestamp": 87,
"parent_workflow_exec_id": null,
"root_workflow_exec_id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"workflow_exec_id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"workflow_name": "support-workflow",
"workflow_run_id": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}
]
}