Retrieve Workflow Execution Detail

Beta

GET

https://api.vellum.ai/v1/workflow-executions/:execution_id/detail

GET

/v1/workflow-executions/:execution_id/detail

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_executions.retrieve_workflow_execution_detail(
8     execution_id="execution_id",
9 )

Try it

200Retrieved

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

Path parameters

execution_idstringRequiredformat: "uuid"

Query parameters

prev_span_idstringOptionalformat: "uuid"

Optional keyset cursor span_id to continue from (exclusive)

span_limitintegerOptional

Maximum number of spans to return (for lazy loading)

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

usage_resultslist of objects or null

spanslist of objects

statemap from strings to any or null

Path parameters

Headers

Query parameters

Response