Create Monitoring Event

Beta

POST

https://api.vellum.ai/monitoring/v1/events

POST

/monitoring/v1/events

1 import datetime
2 
3 from vellum import (
4     NodeExecutionInitiatedBody,
5     NodeExecutionInitiatedEvent,
6     Vellum,
7     VellumCodeResourceDefinition,
8 )
9 
10 client = Vellum(
11     api_version="YOUR_API_VERSION",
12     api_key="YOUR_API_KEY",
13 )
14 client.events.create(
15     request=[
16         NodeExecutionInitiatedEvent(
17             body=NodeExecutionInitiatedBody(
18                 node_definition=VellumCodeResourceDefinition(
19                     name="name",
20                     module=["module", "module"],
21                     id="id",
22                 ),
23                 inputs={"inputs": {"key": "value"}},
24             ),
25             id="id",
26             timestamp=datetime.datetime.fromisoformat(
27                 "2024-01-15 09:30:00+00:00",
28             ),
29             trace_id="trace_id",
30             span_id="span_id",
31         ),
32         NodeExecutionInitiatedEvent(
33             body=NodeExecutionInitiatedBody(
34                 node_definition=VellumCodeResourceDefinition(
35                     name="name",
36                     module=["module", "module"],
37                     id="id",
38                 ),
39                 inputs={"inputs": {"key": "value"}},
40             ),
41             id="id",
42             timestamp=datetime.datetime.fromisoformat(
43                 "2024-01-15 09:30:00+00:00",
44             ),
45             trace_id="trace_id",
46             span_id="span_id",
47         ),
48     ],
49 )

Try it

1 {
2   "count": 1,
3   "success": true
4 }

Accept an event or list of events and publish them to ClickHouse for analytics processing.

Authentication

X-API-KEYstring

API Key authentication via header

Request

This endpoint expects a list of objects or an object.

list of objectsRequired

objectRequired

Response

countinteger

Number of events processed

successboolean or nullDefaults to true

Indicates whether the event was published successfully.

Create Monitoring Event

Authentication

Headers

Request

Response

Errors