Retrieve Workflow Deployment Execution

Beta

GET

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

GET

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

1 curl https://api.vellum.ai/v1/workflow-deployments/id/execution-events/execution_id \
2      -H "X-API-KEY: <apiKey>"

Try it

200Retrieved

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

Path parameters

execution_idstringRequiredformat: "uuid"

idstringRequiredformat: "uuid"

Response

span_idstringformat: "uuid"

parent_contextobject or null

startstringformat: "date-time"

endstring or nullformat: "date-time"

inputslist of objects

outputslist of objects

errorobject or null

latest_actualobject or null

metric_resultslist of objects

usage_resultslist of objects or null

spanslist of objects

statemap from strings to any or null

Path parameters

Headers

Response