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 from vellum import Vellum
2 
3 client = Vellum(
4     api_version="YOUR_API_VERSION",
5     api_key="YOUR_API_KEY",
6 )
7 client.workflow_deployments.workflow_deployment_event_execution(
8     execution_id="execution_id",
9     id="id",
10 )

Try it

200Retrieved

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

Authentication

X-API-KEYstring

API Key authentication via header

Path parameters

execution_idstringRequiredformat: "uuid"

idstringRequiredformat: "uuid"

Response

span_idstringformat: "uuid"

startstringformat: "date-time"

endstring or nullformat: "date-time"

inputslist of objects

outputslist of objects

errorobject or null

usage_resultslist of objects or null

parent_contextobject or null

latest_actualobject or null

metric_resultslist of objects

spanslist of objects

statemap from strings to any or null

Authentication

Path parameters

Headers

Response