Beta

Workflow Deployment Event Execution

GET

https://api.vellum.ai/v1/workflow-deployments/:id/execution-events/:execution_id

GET

/v1/workflow-deployments/:id/execution-events/:execution_id

1 import { VellumClient } from "vellum-ai";
2 
3 const client = new VellumClient({ apiKey: "YOUR_API_KEY" });
4 await client.workflowDeployments.workflowDeploymentEventExecution("execution_id", "id");

Try it

200Retrieved

1 {
2   "span_id": "span_id",
3   "start": "2024-01-15T09:30:00Z",
4   "inputs": [
5     {
6       "type": "STRING",
7       "id": "id",
8       "name": "name",
9       "value": "value"
10     }
11   ],
12   "outputs": [
13     {
14       "type": "STRING",
15       "id": "id",
16       "name": "name",
17       "value": "value"
18     }
19   ],
20   "metric_results": [
21     {
22       "outputs": [
23         {
24           "type": "STRING",
25           "id": "id",
26           "name": "name"
27         }
28       ],
29       "label": "label",
30       "metric_id": "metric_id"
31     }
32   ],
33   "usage_results": [
34     {
35       "usage": [
36         {
37           "ml_model_usage": {},
38           "ml_model_name": "ml_model_name"
39         }
40       ],
41       "cost": [
42         {
43           "value": 1.1,
44           "unit": "USD"
45         }
46       ]
47     }
48   ],
49   "spans": [
50     {
51       "name": "workflow.execution",
52       "attributes": {
53         "label": "label"
54       },
55       "end_ts": "2024-01-15T09:30:00Z",
56       "events": [
57         {
58           "name": "workflow.execution.initiated",
59           "body": {
60             "workflow_definition": {
61               "name": "name",
62               "module": [
63                 "module"
64               ],
65               "id": "id"
66             },
67             "inputs": {
68               "key": "value"
69             }
70           },
71           "id": "id",
72           "span_id": "span_id",
73           "timestamp": "2024-01-15T09:30:00Z",
74           "trace_id": "trace_id"
75         }
76       ],
77       "span_id": "span_id",
78       "start_ts": "2024-01-15T09:30:00Z",
79       "parent_span_id": "parent_span_id"
80     }
81   ],
82   "parent_context": {
83     "span_id": "span_id",
84     "deployment_id": "deployment_id",
85     "deployment_name": "deployment_name",
86     "deployment_history_item_id": "deployment_history_item_id",
87     "release_tag_id": "release_tag_id",
88     "release_tag_name": "release_tag_name",
89     "workflow_version_id": "workflow_version_id",
90     "parent": {
91       "type": "WORKFLOW",
92       "span_id": "span_id",
93       "workflow_definition": {
94         "name": "name",
95         "module": [
96           "module"
97         ],
98         "id": "id"
99       }
100     },
101     "links": [
102       {
103         "trace_id": "trace_id",
104         "type": "TRIGGERED_BY",
105         "span_context": {
106           "type": "WORKFLOW",
107           "span_id": "span_id",
108           "workflow_definition": {
109             "name": "name",
110             "module": [
111               "module"
112             ],
113             "id": "id"
114           }
115         }
116       }
117     ],
118     "external_id": "external_id",
119     "metadata": {
120       "key": "value"
121     }
122   },
123   "end": "2024-01-15T09:30:00Z",
124   "error": {
125     "message": "message",
126     "code": "WORKFLOW_INITIALIZATION"
127   },
128   "latest_actual": {
129     "output": {
130       "type": "STRING",
131       "id": "id",
132       "name": "name",
133       "value": "value"
134     },
135     "timestamp": "2024-01-15T09:30:00Z",
136     "quality": 1.1,
137     "metadata": {
138       "key": "value"
139     }
140   }
141 }

Path parameters

execution_idstringRequired

idstringRequired

Response

span_idstringformat: "uuid"

startdatetime

inputslist of objects

outputslist of objects

metric_resultslist of objects

usage_resultslist of objects

spanslist of objects

parent_contextobjectOptional

enddatetimeOptional

errorobjectOptional

latest_actualobjectOptional

Path parameters

Headers

Response